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.

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

[docs] generate api docs from prop-types, sync to website #399

Merged
merged 42 commits into from
Jan 4, 2019

Conversation

hshoff
Copy link
Member

@hshoff hshoff commented Jan 4, 2019

Still need to document each prop for all packages, but automating the documentation of prop-types is big step forward.

screen shot 2019-01-03 at 9 23 34 pm

screen shot 2019-01-03 at 9 23 15 pm

changelog

📝 Documentation

  • [docs] use react-docgen to generate docs from prop-types and comments.

🏠 Internal

@hshoff hshoff added this to the v0.0.183 milestone Jan 4, 2019
Copy link
Collaborator

@williaster williaster left a comment

Choose a reason for hiding this comment

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

had a couple comments but looks great overall, this will be a huge win! 🏆 🍹

"test": "jest"
"test": "jest",
"docs":
"cd ./docs && ../../../node_modules/.bin/react-docgen ../src/annotations/ | ../../../scripts/buildDocs.sh"
Copy link
Collaborator

Choose a reason for hiding this comment

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

just noting that most of the docs scripts have 2 spaces before the pipe .._ _|<space>_.. prob not a big issue but thought I'd point it out in case it wasn't intentional.

@hshoff hshoff merged commit ceee076 into master Jan 4, 2019
@hshoff hshoff deleted the harry-docgen branch January 4, 2019 20:32
@hshoff hshoff restored the harry-docgen branch January 4, 2019 20:47
@hshoff hshoff deleted the harry-docgen branch August 19, 2020 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants