Skip to content

feat: add docs generator#57

Open
jcreamer898 wants to merge 1 commit intoeventbrite:masterfrom
jcreamer898:jc-docs
Open

feat: add docs generator#57
jcreamer898 wants to merge 1 commit intoeventbrite:masterfrom
jcreamer898:jc-docs

Conversation

@jcreamer898
Copy link
Copy Markdown
Contributor

Adding docs.

Comment thread package.json
"dependencies": {
"isomorphic-fetch": "^2.2.1"
"isomorphic-fetch": "^2.2.1",
"typedoc": "^0.14.2"
Copy link
Copy Markdown
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
Copy Markdown

Choose a reason for hiding this comment

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

Ah, yes.

Comment thread .gitignore
lib/
dist/

apidocs No newline at end of file
Copy link
Copy Markdown
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
Copy Markdown

Choose a reason for hiding this comment

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

Github pages?

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants