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

docs: Provide a clear path through the docs for users trying to get started #275

Open
5 of 9 tasks
Tracked by #143
ethanjli opened this issue Oct 31, 2023 · 2 comments
Open
5 of 9 tasks
Tracked by #143
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ethanjli
Copy link
Member

ethanjli commented Oct 31, 2023

Motivation

Currently, the new docs site doesn't provide a clear path of navigation for users who are looking for practical steps to take in order to use their PlanktoScopes. We should have user-centered documentation for the various kinds of users of the PlanktoScope.

Goals

  • Provide clear and easy navigation for newcomers to the PlanktoScope project
  • Provide clear and easy navigation for people who know how to use PlanktoScopes and want to understand it more deeply

Steps

  • Reorganize docs pages
  • Provide easy entrypoints to various paths through the documentation from the docs site's home page
  • Add index pages for top-level categories
  • Add links to "next steps" pages for docs pages of the "guide" type
  • Update the operation documentation for the PlanktoScope's new wifi hotspot naming scheme, URL, and landing page
  • Add a section for bringup testing and first-boot troubleshooting of newly-assembled hardware (see also docs: Write a detailed getting started guide #19)
  • Add troubleshooting guides
  • Rewrite the community section
  • Provide a clear path through the technical reference, and a clear structure for the technical reference

Unresolved Questions

Implementation History

@ethanjli
Copy link
Member Author

I'm adding this to the software v2023.9.0 milestone specifically for the "Update the operation documentation for the PlanktoScope's new wifi hotspot naming scheme, URL, and landing page" task, to make sure I don't forget to do it for v2023.9.0. However, the other remaining tasks in this issue are out-of-scope for v2023.9.0, and I will move this issue back into the Backlog milestone afterwards.

@ethanjli ethanjli changed the title Provide a clear path through the docs for users trying to get started docs: Provide a clear path through the docs for users trying to get started Nov 23, 2023
@ethanjli
Copy link
Member Author

Since #294 finishes the part of this issue which needs to be completed for the software v2023.9.0 milestone, I will remove this issue from that milestone.

@ethanjli ethanjli added the documentation Improvements or additions to documentation label Dec 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🏗 In progress
Development

No branches or pull requests

1 participant