Add Docusaurus documentation site with Mermaid support#1
Merged
Conversation
- Add Docusaurus 3.5.2 site in website/ directory
- Configure Mermaid diagram rendering with @docusaurus/theme-mermaid
- Add GitHub Actions workflow for GitHub Pages deployment
- Add Dependabot configuration with grouped updates
- Add prepare-docs.js script to transform docs at build time:
- Adds frontmatter (id, title, sidebar_position)
- Escapes MDX special characters ({}, <>)
- Source docs remain unchanged - transformation happens at build
- Update .gitignore for website build artifacts
Run locally with:
cd website && npm install && npm start
chrisns
force-pushed
the
feat/docusaurus-docs-site
branch
from
ec7a175 to
9cf7ddc
Compare
chrisns
had a problem deploying
to
github-pages
GitHub Actions
Failure
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Feb 4, 2026
* feat: Add Docusaurus documentation site with Mermaid support
- Add Docusaurus 3.5.2 site in website/ directory
- Configure Mermaid diagram rendering with @docusaurus/theme-mermaid
- Add GitHub Actions workflow for GitHub Pages deployment
- Add Dependabot configuration with grouped updates
- Add prepare-docs.js script to transform docs at build time:
- Adds frontmatter (id, title, sidebar_position)
- Escapes MDX special characters ({}, <>)
- Source docs remain unchanged - transformation happens at build
- Update .gitignore for website build artifacts
Run locally with:
cd website && npm install && npm start
* fix: Update footer to GDS/DSIT and add build info with git SHA link
* ci: Temporarily deploy from feature branch for testing
* feat: Redirect homepage to /docs/
* fix: Use useBaseUrl for redirect to respect baseUrl
* ci: Restore main-only deployment
* ci: Run build on PRs, deploy only on main
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Feb 4, 2026
* feat: Add Docusaurus documentation site with Mermaid support
- Add Docusaurus 3.5.2 site in website/ directory
- Configure Mermaid diagram rendering with @docusaurus/theme-mermaid
- Add GitHub Actions workflow for GitHub Pages deployment
- Add Dependabot configuration with grouped updates
- Add prepare-docs.js script to transform docs at build time:
- Adds frontmatter (id, title, sidebar_position)
- Escapes MDX special characters ({}, <>)
- Source docs remain unchanged - transformation happens at build
- Update .gitignore for website build artifacts
Run locally with:
cd website && npm install && npm start
* fix: Update footer to GDS/DSIT and add build info with git SHA link
* ci: Temporarily deploy from feature branch for testing
* feat: Redirect homepage to /docs/
* fix: Use useBaseUrl for redirect to respect baseUrl
* ci: Restore main-only deployment
* ci: Run build on PRs, deploy only on main
Add link to browse the documentation at https://co-cddo.github.io/ndx-try-arch/
The merge queue requires workflows to listen for the merge_group event to run checks on the temporary merge branch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
website/directoryFeatures
maintriggers deployment to GitHub Pages../docs/(gitignored)Local Development
cd website npm install npm startSite will be available at http://localhost:3000/ndx-try-arch/
After Merge
Enable GitHub Pages in repo settings:
Test Plan
npm startruns successfully