mirror of
https://github.com/svnscha/mcp-windbg.git
synced 2026-10-18 21:51:54 +08:00
c3c3c7fa57
## Summary Onboards a MkDocs (Material) documentation site, mirroring the dap-dbgeng setup, and migrates the GitHub wiki into it (trimmed to the essentials: getting started, use cases, and a lookup reference). ## What's included **Site infrastructure** - `mkdocs.yml` - Material theme, VS Code blue palette, light/dark toggle, the same markdown extensions and nav structure as dap-dbgeng. - `requirements-docs.txt` - pinned `mkdocs` / `mkdocs-material` / `pymdown-extensions`. - `docs/assets/` - `extra.css` (brand color + mermaid styling) and the self-contained `mermaid.js` loader. **Pipeline** - `.github/workflows/pages.yml` - builds with `mkdocs build --strict` and deploys to GitHub Pages on pushes to `main` that touch docs. **Content (migrated + trimmed from the wiki)** - `index.md`, `getting-started.md` - Use cases: `scenarios/` - analyze a crash dump, debug a remote target, triage multiple dumps - Reference: `reference/` - command-line options, tools, client configuration - `troubleshooting.md` **Agent / authoring setup** - Migrated `AGENTS.md` -> `CLAUDE.md` (concise, dap-dbgeng style). - Added `.claude/rules/markdown.md` and `.claude/rules/documentation.md`, plus `scripts/Format-Docs.ps1` to enforce the typography rules (plain hyphens, no emojis). **Housekeeping** - README documentation links now point at the new site. - `.gitignore` ignores `/site/`. ## Verification - `mkdocs build --strict` - clean, all internal links resolve. - `scripts/Format-Docs.ps1 -Check` - passes repo-wide (also fixed a stray dash + emoji in CHANGELOG). ## One manual step GitHub Pages is not enabled on the repo yet. After merge, set **Settings -> Pages -> Build and deployment -> Source = GitHub Actions** (one time) so `pages.yml` can publish to `https://svnscha.github.io/mcp-windbg/`. Happy to enable it via API if you'd prefer. ## Notes / decisions - Use-case pages chosen to match the product: crash dump, remote target, triage. The wiki's separate per-client install pages are consolidated into `reference/clients.md`. - The wiki repo (`mcp-windbg.wiki`) is left untouched; we can archive or redirect it once this is live. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
43 lines
1.3 KiB
CSS
43 lines
1.3 KiB
CSS
/* ---- Brand color: VS Code blue ---------------------------------------- */
|
|
/* Override on the scheme element (where Material sets these vars) with
|
|
!important so the palette's own "blue" preset does not win. */
|
|
[data-md-color-scheme="default"] {
|
|
--md-primary-fg-color: #007acc !important;
|
|
--md-primary-fg-color--light: #3393d6 !important;
|
|
--md-primary-fg-color--dark: #005a9e !important;
|
|
--md-accent-fg-color: #0098ff !important;
|
|
--md-typeset-a-color: #007acc !important;
|
|
}
|
|
[data-md-color-scheme="slate"] {
|
|
--md-primary-fg-color: #0a84d8 !important;
|
|
--md-primary-fg-color--light: #3393d6 !important;
|
|
--md-primary-fg-color--dark: #005a9e !important;
|
|
--md-accent-fg-color: #3794ff !important;
|
|
--md-typeset-a-color: #3794ff !important;
|
|
}
|
|
|
|
/* ---- Mermaid diagrams -------------------------------------------------- */
|
|
/* Stop node/edge label text from being clipped inside boxes and backgrounds. */
|
|
.mermaid-rendered {
|
|
margin: 1em 0;
|
|
overflow-x: auto;
|
|
text-align: center;
|
|
}
|
|
.mermaid-rendered svg {
|
|
max-width: 100%;
|
|
height: auto;
|
|
}
|
|
/* foreignObject clips by default; let label text render in full. */
|
|
.mermaid-rendered foreignObject {
|
|
overflow: visible;
|
|
}
|
|
.mermaid-rendered .nodeLabel,
|
|
.mermaid-rendered .edgeLabel,
|
|
.mermaid-rendered .label {
|
|
line-height: 1.4;
|
|
}
|
|
.mermaid-rendered .nodeLabel p,
|
|
.mermaid-rendered .edgeLabel p {
|
|
margin: 0;
|
|
}
|