website: add the outline for the 2.0 documentation#463
Conversation
|
Preview: https://abetomo.github.io/openarm See https://github.com/enactic/openarm/blob/main/website/README.md#pull-request-and-preview how to configure preview on fork. |
There was a problem hiding this comment.
Pull request overview
Adds initial scaffolding for the website documentation re-org (v2.0 outline) by introducing new top-level sections and placeholder pages so navigation structure can be built out incrementally.
Changes:
- Add new Tutorial section with placeholder docs (Setup, Inference, Data collection).
- Add new Dataset section with placeholder docs (Dataset, Dataset API).
- Rename/reorder sidebar categories (e.g., Hardware → Manufacturing; Software → API Reference) and add generated index links for new sections.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/tutorial/setup.mdx | New placeholder tutorial page |
| website/docs/tutorial/inference.mdx | New placeholder tutorial page |
| website/docs/tutorial/data-collection.mdx | New placeholder tutorial page |
| website/docs/tutorial/category.json | Adds Tutorial category + generated index |
| website/docs/manufacturing/category.json | Renames/repositions category to “Manufacturing” |
| website/docs/dataset/dataset.mdx | New placeholder dataset page |
| website/docs/dataset/api.mdx | New placeholder dataset API page |
| website/docs/dataset/category.json | Adds Dataset category + generated index |
| website/docs/api-reference/category.json | Renames/repositions category + adds generated index |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| title: Setup | |||
There was a problem hiding this comment.
Most docs in this repo set an explicit sidebar_position in the frontmatter for stable sidebar ordering; this new page omits it, which can lead to unpredictable ordering as more tutorial pages are added. Add sidebar_position (and optionally sidebar_label if you want it to differ from the title) to match the existing docs conventions.
| title: Setup | |
| title: Setup | |
| sidebar_position: 1 |
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| title: Inference | |||
There was a problem hiding this comment.
Most docs in this repo set an explicit sidebar_position in the frontmatter for stable sidebar ordering; this new page omits it, which can lead to unpredictable ordering as more tutorial pages are added. Add sidebar_position (and optionally sidebar_label if you want it to differ from the title) to match the existing docs conventions.
| title: Inference | |
| title: Inference | |
| sidebar_position: 1 |
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| title: Data collection | |||
There was a problem hiding this comment.
Most docs in this repo set an explicit sidebar_position in the frontmatter for stable sidebar ordering; this new page omits it, which can lead to unpredictable ordering as more tutorial pages are added. Add sidebar_position (and optionally sidebar_label if you want it to differ from the title) to match the existing docs conventions.
| title: Data collection | |
| title: Data collection | |
| sidebar_position: 1 |
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| title: Data collection | |||
There was a problem hiding this comment.
The title is not in the same Title Case style used by most other doc pages (e.g., "Project Overview", "Safety Guide"). Consider changing "Data collection" to "Data Collection" for consistency in the sidebar and page header.
| title: Data collection | |
| title: Data Collection |
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| title: Dataset | |||
There was a problem hiding this comment.
Most docs in this repo set an explicit sidebar_position in the frontmatter for stable sidebar ordering; this new page omits it, which can lead to unpredictable ordering as more dataset pages are added. Add sidebar_position (and optionally sidebar_label) to match the existing docs conventions.
| title: Dataset | |
| title: Dataset | |
| sidebar_position: 1 |
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| title: Dataset API | |||
There was a problem hiding this comment.
Most docs in this repo set an explicit sidebar_position in the frontmatter for stable sidebar ordering; this new page omits it, which can lead to unpredictable ordering as more dataset pages are added. Add sidebar_position (and optionally sidebar_label) to match the existing docs conventions.
| title: Dataset API | |
| title: Dataset API | |
| sidebar_position: 1 |
| "position": 1, | ||
| "link": { | ||
| "type": "generated-index", | ||
| "description": "Getting started guide for OpenArm 1." |
There was a problem hiding this comment.
The category label was renamed to "Overview", but the generated-index description still refers to a "Getting started" guide for "OpenArm 1". If this PR is intended to start the 2.0 docs outline, update the description to match the new section name and avoid version-specific wording that’s now likely outdated.
| "description": "Getting started guide for OpenArm 1." | |
| "description": "Overview of OpenArm documentation." |
No description provided.