Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add docs generator #57

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add docs generator #57

wants to merge 1 commit into from

Conversation

jcreamer898
Copy link
Contributor

Adding docs.

kwelch-eb
kwelch-eb reviewed Jan 29, 2019
View reviewed changes
package.json
@@ -50,7 +51,8 @@
]
},
"dependencies": {
"isomorphic-fetch": "^2.2.1"
"isomorphic-fetch": "^2.2.1",
"typedoc": "^0.14.2"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't this be a devDep?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes.

.gitignore
@@ -49,3 +49,5 @@ jspm_packages/
# Target files
lib/
dist/

apidocs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignore for committing makes sense. Should we make sure to include it in our files for npm though? How will these surface?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Github pages?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh cool!

@kwelch-eb
Copy link
Contributor

Looks good, we should get this added to all of our stuff. Much easier to write docs in context of the code when possible.

@kwelch
Copy link
Contributor

kwelch commented Jan 29, 2019

Can you make sure to remove any docs that this would replace as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonathancreamer-eb jonathancreamer-eb jonathancreamer-eb left review comments

@kwelch-eb kwelch-eb kwelch-eb left review comments

@kwelch kwelch kwelch left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jcreamer898 @kwelch-eb @kwelch @jonathancreamer-eb