-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is needed
Description
These three pages need to be reworked such that the reader understands the core features and context in 5 minutes:
- https://ctu-mrs.github.io
- https://ctu-mrs.github.io/docs/introduction/
- https://github.com/ctu-mrs/mrs_uav_system
What's to be included:
- overview images (Tomas: you mean pictures?) and key features
- licensing
- target audience
- quick start tutorial
- high-level architecture diagram and data flow
- list codebase, APIs and libraries
- how does our typical HW setup look like and how to set up it
- basic operation (Tomas: please elaborate)
- where and how to ask for support/questions/troubleshooting
- references, resources
Most of this is inside the documentation itself, but a 5-minute read here must give the reader the basic functionality and context. After reading this summary, the readers MUST know what it's for and how it can be used. It should be visual as much as possible, with the visuals being as straightforward as possible.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is needed