Skip to content

Upgrade to Docusaurus 3 and align with SMA docs standards#58

Merged
MoKranda merged 1 commit into
mainfrom
docs/standardization-and-docusaurus-3-upgrade
May 4, 2026
Merged

Upgrade to Docusaurus 3 and align with SMA docs standards#58
MoKranda merged 1 commit into
mainfrom
docs/standardization-and-docusaurus-3-upgrade

Conversation

@rweesner
Copy link
Copy Markdown
Contributor

@rweesner rweesner commented May 4, 2026

Summary

  • Docusaurus 3.10.1 upgrade — updated from 2.0.0-beta.20; React upgraded to 18, Node pinned to 20 in workflows and volta config; deprecated onBrokenMarkdownLinks moved to markdown.hooks
  • Technical-writer skill imported — CLAUDE.md created; .claude/skills/technical-writer/ populated with SKILL.md and all 7 resource files from opcon-docs
  • Site structure aligned to opcon-docs/windows-agent-docs — breadcrumbs enabled, full shared CSS applied, index page converted to card-style link menu with sidebar hidden, release notes moved to second sidebar position
  • Overview pages addeddocs/overview.md (top-level) and section overviews for Installation, Administration, Operations, and Reference; sidebar category titles linked to their respective overview pages
  • Release notes reformatted — now matches windows-agent-docs style (version grouping, What's new, Why this matters, Fixes sections, front matter)
  • All docs pages updated — front matter added to every page; banned terms replaced (click → Select, execute/executing → run/running); What is it?, FAQs, and Glossary sections added throughout
  • Installation page readability improved — requirements converted to table, three-phase orientation added, service startup caution repositioned, 23-step machine creation split into three labeled sub-procedures

Test plan

  • Verify yarn build passes (confirmed locally — 82 documents, no errors)
  • Verify CI build workflow passes on this branch
  • Spot-check index page card layout renders correctly
  • Verify sidebar category titles are clickable links to their overview pages
  • Verify breadcrumbs appear on content pages
  • Verify release notes format matches windows-agent-docs

🤖 Generated with Claude Code

…andards

- Upgrade Docusaurus from 2.0.0-beta.20 to 3.10.1; update React to 18, Node to 20 in workflows and volta config
- Import CLAUDE.md and technical-writer skill (SKILL.md + 7 resource files) from opcon-docs
- Enable breadcrumbs; replace minimal CSS with full opcon-docs/windows-agent-docs stylesheet
- Convert index page to card-style link menu (displayed_sidebar: null); create docs/overview.md with What is it?, FAQs, Glossary
- Add section overview pages for Installation, Administration, Operations, and Reference; link sidebar category titles to each overview via Docusaurus link property
- Move release-notes to second sidebar position; set all categories to collapsed: true
- Reformat release notes to windows-agent-docs style (version grouping, What's new, Why this matters, Fixes)
- Add front matter, What is it?, FAQs, and Glossary to all docs pages; replace banned terms (click, execute/executing, drop-down, task) throughout
- Improve installation page readability: requirements table, three-phase orientation, service startup caution repositioned, machine creation split into three labeled sub-procedures

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@rweesner rweesner requested a review from a team as a code owner May 4, 2026 21:14
@rweesner rweesner requested a review from MoKranda May 4, 2026 21:17
@rweesner rweesner self-assigned this May 4, 2026
@MoKranda MoKranda merged commit 1dc47a0 into main May 4, 2026
1 check passed
@MoKranda MoKranda deleted the docs/standardization-and-docusaurus-3-upgrade branch May 4, 2026 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants