Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

Improve navigability #741

Open
4 of 5 tasks
degville opened this issue Jan 15, 2018 · 0 comments
Open
4 of 5 tasks

Improve navigability #741

degville opened this issue Jan 15, 2018 · 0 comments
Assignees

Comments

@degville
Copy link
Contributor

degville commented Jan 15, 2018

Update current documentation structure to improve the following:

  • general navigability; current split of top level headings (ie. Introduction/Nodes/API) isn't optimal.
  • new user on-boarding and discovery; There's currently no obvious path through the docs, especially when a reader may be unfamiliar with the concepts and terms. Add Get Started section.
  • added walkthroughs; maybe within their own section. There should a quickstart walkthrough to cover the general installation and use, plus more hand-on guides for common tasks.

Steps to solve this issue:

#742 is a related issue.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant