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

Feedback from doc review #17

Open
misslivirose opened this issue Mar 31, 2020 · 0 comments
Open

Feedback from doc review #17

misslivirose opened this issue Mar 31, 2020 · 0 comments

Comments

@misslivirose
Copy link
Contributor

Add a welcome/introduction type article at the top of articles: orientate people first coming to that section, telling them what that documentation will allow them to achieve, who it is for, what it's about, etc. I'd advise putting a similar introduction type article at the top of all the sections, particularly:

Hubs Documentation - Consider "Hubs user guide" or similar since all of this documentation falls under the branch of 'Hubs Documentation'
Spoke Documentation - say what spoke is, who it is for, and what kinds of things you can do with it. What is the basic stuff people will want to try, and what are the most advanced bits to go onto later on
For Creators - May not be clear who this document is for
For Developers - Audience here may not be clear; it's also not clear if/how Hubs Cloud documentation is different than the general developer resources

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

No branches or pull requests

1 participant