Hubs-Foundation / Hubs-Foundation/hubs-docs

Feedback from doc review

Open
#17 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
28
Forks
181
Avg merge
13h 13m
Merged PRs (30d)
1

Description

> 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

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Hubs Documentation, Spoke Documentation, For Creators, and For Developers sections to understand their current audience and structure. Done means each relevant section has a welcome or introduction article explaining who it is for, what it covers, and what readers can achieve, including the distinction between Hubs Cloud and general developer resources.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.