Documentation navigation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the Ocean docs starting page, the Getting Started and Ocean Software Stack sections, the Tools page, and the sidebar examples described in the issue. Done means the navigation consistently distinguishes Ocean documentation from general D-Wave documentation and makes the Tools documentation discoverable from Getting Started.
Written by the indexing model from the issue text.
Description
These opinions come from my experience learning the Ocean SDK from the documentation directly and some code examples.
Sidebar:
I feel that there should be more distinction in the sidebar which links are part of the ocean documentation, and which is part of the more general dwave system documentation.
The "D-Wave" section (containing links for D-Wave, Leap, and D-Wave System Documentation) seems to be part of the ocean documentation. Maybe it should be forced to the bottom of the navbar or each entry should be indented to show that it is part of another section.
Tools:
I did not immediately correlate this section as the location for the documentation (even though it is clearly labelled at the Ocean docs starting page), and I think this was because I was immediately gravitated towards the "Getting Started" section which does not feature a link to the individual tools documentation. Perhaps this can be mitigated by linking the "Tools" main page in the "Getting Started" page. After viewing this page again, I now realize it is accessible via the "Ocean Software Stack" section, but might be worth having its own description section.
Edit:
I have just noticed that the "sub-pages" (tool specific documentation) has a more clear distinction in the navbar. Seems this may just be due to inconsistent style.
Example:
Compared with:
- Dominant language
- Python
- Stars
- 49
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dwavesystems/docs
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
dwavesystems/docs#74 · 2 comments ·
-
dwavesystems/docs#73 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
dwavesystems/docs#71 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 45/100
dwavesystems/docs#67 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
dwavesystems/docs#55 ·
All issues in dwavesystems/docs
Similar issues
-
agent-ready documentation needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
instance instance add
Difficulty 1/5 Under an hour Newbie friendliness 72/100
searxng/searx-instances#939 · 1 comment ·
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100