Skip to content

docs: establish WaveBench documentation workflow - #17

Merged
Scaxlibur merged 14 commits into
masterfrom
Scaxlibur/docs/wavebench-docs-workflow
Sep 3, 2026
Merged

docs: establish WaveBench documentation workflow#17
Scaxlibur merged 14 commits into
masterfrom
Scaxlibur/docs/wavebench-docs-workflow

Conversation

@Scaxlibur

Copy link
Copy Markdown
Owner

Summary

  • add the repo-local wavebench-docs skill with audit, migrate, write, and diff-focused review modes
  • establish canonical-source, Core/plugin, document lifecycle, and collaboration-output rules
  • reorganize current documentation into task-oriented entry points while preserving short compatibility pages and historical archives
  • add deterministic documentation auditing, generated run-schema reference checks, diff-impact guidance, and CI integration
  • add a MkDocs Material site configuration and refresh the README landing page

Validation

  • full documentation audit: 0 errors; 9 accepted historical, long-page, navigation, or README H1 warnings
  • pytest -q tests/test_docs_audit.py tests/test_docs_generation.py tests/test_docs_impact.py: 10 passed
  • python scripts/generate_docs.py --check
  • python -m mkdocs build --strict
  • repository skill validation and Chinese documentation style checks
  • git diff --check

Safety and scope

  • no live instruments were connected
  • no local bench configuration or experimental data was modified
  • this PR does not enable or deploy GitHub Pages

@Scaxlibur
Scaxlibur merged commit 0b348ab into master Sep 3, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant