Docs: Enable documentation section of website#95
Conversation
Signed-off-by: Ed Snible <snible@us.ibm.com>
✅ Deploy Preview for animated-crumble-fb8862 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Ed Snible <snible@us.ibm.com>
mrsabath
left a comment
There was a problem hiding this comment.
Clean enablement of the website Docs section, now that #2253 provides the reorganized + draft-gated content. Flips docs: false → enabled, restores the Documentation navbar item, wraps the sidebar in a generated-index root category, and teaches sync-docs.sh to slug the synced README.md so it doesn't collide with the generated-index root route.
Verified against the current repo + #2253:
- Status/pill parity:
welcome.mdxuses exactlyReady/beta in 0.7/alpha in 0.7, andSTATUS_CLASSmaps all three — no orphaned status or dead map key (plus a?? ''fallback for safety). - CTA route valid:
/docs/overview/quickstartresolves —routeBasePath: 'docs'and quickstart exists in #2253, not draft-gated. - sync-docs README slug handling is well-reasoned: guards against pre-existing frontmatter and keeps the README→index link rewrite so cross-links don't break.
Verdict: APPROVE — correct enablement, verified parity and route, sound sync handling.
Minor (non-blocking, no change needed): the empty exclude: [] block is a leftover scaffold with stray whitespace; the dropped "Try RossoCortex" CTA reads as a deliberate content choice now that docs are live.
Depends on #2253 (the content source — approved and green); merge it first so the synced docs/ exists at build time.
Areas reviewed: Docusaurus config/sidebar, sync-docs shell, React component (status-map parity), content. Commits: 2, signed-off. CI: passing.
Summary
Currently the 'Documentation' section of the website is disabled.
This enables the section, plus a few small changes I needed to make it render correctly.
(Optional) Testing Instructions
Do
SRC_REPO=~/src/rossoctl npm run sync-docs && npm run build && npm run serve(modify the
SRC_REPOif your clone of rossoctl is elsewhere)Note that we need to build because we are using the
draftfeature to exclude content we don't want on the website.