docs: MkDocs Material site + refresh AI_STATUS to v4.2.0#61
Closed
RFingAdam wants to merge 2 commits into
Closed
Conversation
Public-facing documentation site published from /docs to GitHub Pages. What's included: - mkdocs.yml + docs/requirements.txt (MkDocs Material, include-markdown) - docs/ tree: index, getting-started, hardware, user-guide (9 measurement types), mcp (overview/install/tools/recipes/troubleshooting), ai (overview/status/providers/chat/reports), reference (cli/api/glossary), contributing - .github/workflows/docs.yml — strict build on every push touching docs; deploy to gh-pages on push to main - README docs badge + nav links - AI_STATUS.md refreshed: v4.1.5 → v4.2.0, 20 → 34 MCP tools, cal-drift category, process_folder orchestrator, shipped-roadmap pruning, last updated 2026-05-12 - contributing.md and ai/status.md mirror CONTRIBUTING.md and AI_STATUS.md via mkdocs-include-markdown-plugin so the canonical sources stay in the repo root - .gitignore: add site/ (MkDocs build output) Cross-doc references in AI_STATUS.md and CONTRIBUTING.md rewritten to absolute GitHub URLs so they resolve both in the repo view and in the included pages on the docs site. Verification: mkdocs build --strict completes with no warnings. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add docs/assets/logo.svg (Smith-chart brand logo) used as both site logo and favicon - Custom theme colors (indigo + cyan accent), Inter + JetBrains Mono font pair, instant-loading navigation, toc.follow - New docs/stylesheets/extra.css: brand colors, card grid for the landing page, hero strip, screenshot framing, themed table headers - Rewrite docs/index.md as a hero landing with logo, card grid, and a tabbed screenshot gallery (passive 3D / 2D, datasheet, active 2D, VNA, group delay) - Embed relevant screenshots in passive-gain, active-trp, s11-impedance, group-delay, and ai/providers pages so each topic has a real visual reference instead of just text mkdocs build --strict still passes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4 tasks
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
Public-facing documentation site at https://rfingadam.github.io/RFlect/ once Pages is enabled, plus a refreshed AI_STATUS.
Base branch is
process-folder-mcpso this PR only shows the docs diff. Merge that PR (#60) first, then this one rebases naturally onto main.What's included
mkdocs.yml+docs/requirements.txt— Material theme, search, code copy, dark/light toggle,mkdocs-include-markdown-plugindocs/tree:process_folder/ troubleshooting.github/workflows/docs.yml— strictmkdocs buildon push to docs paths; deploy togh-pageson push tomainAI_STATUS.mdrefreshed: v4.1.5 → v4.2.0, 20 → 34 MCP tools, cal-drift category,process_folderdocumented, shipped-roadmap items pruned, last updated 2026-05-12.gitignoreexcludessite/(MkDocs build output)Cross-doc references in
AI_STATUS.mdandCONTRIBUTING.mdwere rewritten to absolute GitHub URLs so they resolve both in the repo view and in the included pages on the docs site.Test plan
mkdocs build --strict— clean, 0 warnings, 0 info-level link issuesgh-pagesbranch is createdgh-pages, root → site goes live at https://rfingadam.github.io/RFlect/🤖 Generated with Claude Code