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

Documentation: Adding the packages READMEs to the handbook #7632

Merged
merged 4 commits into from
Jun 29, 2018

Conversation

youknowriad
Copy link
Contributor

This PR adds the packages READMEs to the handbook grouped under a "packages" section. This makes it easier to navigate between the docs of the different packages.

For now, I'm just using the README but we could imagine adding support for a docs folder per package if the package is important enough to require multiple pages of docs.

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Jun 29, 2018
@youknowriad youknowriad self-assigned this Jun 29, 2018
@youknowriad youknowriad requested a review from a team June 29, 2018 11:29
Copy link
Member

@tofumatt tofumatt left a comment

Choose a reason for hiding this comment

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

I made a few tweaks (pkg > packageName, templates strings over string concat, and clarifying what npmReady package means).

Looks good. If you're cool with my changes, 🚢

@youknowriad
Copy link
Contributor Author

Thanks for the tweaks @tofumatt

@youknowriad youknowriad merged commit 8f58e27 into master Jun 29, 2018
@mtias mtias deleted the add/packages-docs branch June 29, 2018 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants