Skip to content

Upgrade to Docusaurus 3 and rewrite docs for readability#67

Merged
MoKranda merged 1 commit into
mainfrom
docusaurus-3-and-docs-rewrite
May 7, 2026
Merged

Upgrade to Docusaurus 3 and rewrite docs for readability#67
MoKranda merged 1 commit into
mainfrom
docusaurus-3-and-docs-rewrite

Conversation

@rweesner
Copy link
Copy Markdown
Contributor

@rweesner rweesner commented May 7, 2026

Summary

  • Upgrade Docusaurus 2.0.0-beta.20 → 3.10.1, React 17 → 18, MDX 2 → 3, and pin Node 20 via engines and .nvmrc. CI workflows already bumped to Node 20.
  • Fix MDX 3 incompatibilities (Pandoc [Text]{.Class} syntax and <Var\> JSX-like placeholders) so the build passes cleanly.
  • Restructure the site to match opcon-docs / windows-agent-docs: card-grid index, breadcrumbs on, sidebar auto-collapse, release notes promoted to second sidebar slot with major-version groupings, section overview pages wired to each category title.
  • Apply the technical-writer skill (imported under .claude/skills/) across every doc page: front matter, sentence-case headings, customer-facing terminology, procedural lead-ins, and What is it? / FAQs / Glossary / Related topics sections where appropriate.
  • Convert the SQL job actions reference to use Docusaurus tabs so users can switch between configuration variants without scrolling through every example image.

Test plan

  • yarn install (Docusaurus 3.10.1, react 18, MDX 3) completes without errors
  • yarn build succeeds — generates 147 documents, no broken anchors, no broken links
  • yarn start runs the dev server cleanly on Node 20+
  • Spot-check the deployed help site after merge: index card grid, breadcrumbs, sidebar collapse, job-actions tabs render and persist selection across reloads
  • Confirm the legacy Enterprise Manager references on installation/admin pages are still correct (flagged for SME — not silently replaced with Solution Manager)

Notes

  • 8 new pages: top-level overview.md plus a section overview page for each of installation, administration, advanced features, reference.
  • One page renamed in title only: Managing the LSAMManage the SQL Agent service. The filename manage-lsam.md was retained so URLs do not break.

🤖 Generated with Claude Code

Upgrade Docusaurus from 2.0.0-beta.20 to 3.10.1 with React 18 and MDX 3,
and pin Node.js to 20 via engines and .nvmrc. Fix MDX 3 incompatibilities
(Pandoc attribute syntax, JSX-like angle-bracket placeholders) so the build
passes cleanly.

Rebuild the site structure to match opcon-docs and windows-agent-docs:
card-grid index page, breadcrumbs enabled, sidebar auto-collapse, release
notes restructured with major-version groupings, release notes promoted to
the second sidebar slot, and section overview pages wired to each category.

Apply the technical-writer skill (imported under .claude/skills/) across
every doc page: front matter, sentence-case headings, customer-facing
terminology, procedural lead-ins, and "What is it?", "FAQs", "Glossary",
and "Related topics" sections where appropriate. Each page now opens with
a use-case bullet list and ends with related links.

Convert the SQL job actions reference to use Docusaurus tabs so users can
switch between configuration variants instead of scrolling through every
example image.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rweesner rweesner requested a review from a team as a code owner May 7, 2026 19:40
@rweesner rweesner self-assigned this May 7, 2026
@rweesner rweesner requested a review from MoKranda May 7, 2026 19:41
@MoKranda MoKranda merged commit e91bc41 into main May 7, 2026
1 check passed
@MoKranda MoKranda deleted the docusaurus-3-and-docs-rewrite branch May 7, 2026 19:47
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