Skip to content

Feature/jazzy devel open rmf documentation - #47

Merged
ATemova merged 2 commits into
jazzy-develfrom
feature/jazzy-devel-open_rmf_documentation
Feb 1, 2026
Merged

Feature/jazzy devel open rmf documentation#47
ATemova merged 2 commits into
jazzy-develfrom
feature/jazzy-devel-open_rmf_documentation

Conversation

@Paveljolak

Copy link
Copy Markdown
Collaborator

Adding initial documentation regarding open-RMF web dashboard to the jazzy development branch in the documentation.

Added:

  • Introduction of what open-RMF dashboard is, what we are using it for and explanation of the basic concepts.
  • User guide where basic features and pages of the dashboard are explained. More details and images for clarity should be added.
  • Advanced Guide - this guide is meant for developers and contributors. It is meant to explain how devs can make changes and customize the dashboard. It lacks the API's for the features, and how the features are implemented. It only has the auth details.

Suggestions for improvement:

  • Adding images of the dashboard and the features throughout the text in the documentation for more clarity.
  • Adding step-by-step guides how to use the specific features. Maybe these can be split into multiple pages (a per feature page, where we can add explanation of the feature, a step-by-step guide on how to use it with images, and a video showing the use of the feature).
  • Adding a proper advanced guide with the APIs and the explanation on how to customize the dashboard.

@ATemova

ATemova commented Feb 1, 2026

Copy link
Copy Markdown
Collaborator

Good initial structure. Clear separation between user-facing and developer-focused documentation. Expanding the advanced guide with API details and adding visual, per-feature guides would further improve clarity.

@ATemova
ATemova merged commit a7d165d into jazzy-devel Feb 1, 2026
@Paveljolak
Paveljolak deleted the feature/jazzy-devel-open_rmf_documentation branch February 12, 2026 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants