Skip to content

Add VitePress user documentation - #108

Merged
drown0315 merged 4 commits into
mainfrom
codex/docs
Jul 2, 2026
Merged

drown0315 merged 4 commits into
mainfrom
codex/docs

Conversation

@drown0315

@drown0315 drown0315 commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • move internal PRDs, ADRs, calibration notes, and design docs to docs-internal so docs can be the public documentation site
  • add a VitePress docs site with guide and reference pages for getting started, Scenario authoring, running Scenarios, CLI usage, and Scenario DSL rules
  • add Scenario DSL documentation checks that parse documented YAML examples with the real parser
  • add docs-specific GitHub Actions for PR checks and GitHub Pages deployment from docs/.vitepress/dist
  • configure VitePress to use /flutter_pilot/ as the GitHub Pages base path while keeping local dev at /

Verification

  • dart analyze
  • dart test
  • dart analyze --fatal-infos --fatal-warnings
  • dart test test/scenario_dsl_docs_test.dart test/scenario_dsl_docs_tool_test.dart
  • dart run tool/check_scenario_dsl_docs.dart
  • npm run docs:build
  • GITHUB_PAGES=true npm run docs:build

Closes #106

@drown0315
drown0315 merged commit e151750 into main Jul 2, 2026
2 checks passed
@drown0315
drown0315 deleted the codex/docs branch July 2, 2026 04:27
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.

Use VitePress for user documentation

1 participant