The docs directory has grown into a real documentation set — using-skills.md, developing-skills.md, the hands-on evaluation tutorial, plus the design-review and validation records under reviews/ — and it is currently readable only as GitHub blob pages. Converting to MyST with a GitHub Actions deployment gives us a navigable site with QuantEcon-standard tooling, proper cross-references, and math rendering when the framework/tutorial content needs it.
Scope
- MyST site config (
myst.yml) with an explicit TOC: the three docs/ guides, the benchmark user guide, and the evaluation framework. Content stays where it lives — the plugin's files (benchmark/README.md, benchmark/references/EVALUATION_FRAMEWORK.md) are included by the site build, never moved out of the plugin, preserving the self-contained-plugin convention in developing-skills.md.
- Source compatibility: files remain GitHub-renderable MyST-flavored markdown — the repo view and the site render from the same sources, no forked copies (per the "one canonical location" convention).
- Link integrity: relative links currently target GitHub blob paths in some places (e.g. the tutorial links
../reviews/..., benchmark README links a blob/main URL). The conversion should normalize these so they resolve in both contexts, and add a link-check to CI.
- GitHub Actions deployment: build the MyST site and publish to GitHub Pages on push to
main; PRs get a build + link-check job (no deploy). Follows the same pattern QuantEcon lecture repos use.
- README points at the published site as the primary entry, with the in-repo files as source.
Non-goals
- No content rewrites — this is rendering/deployment only.
- The plugin payload must remain installable and self-contained exactly as today; the site is a view over the repo, not a restructuring of it.
Acceptance
- Site live at
quantecon.github.io/skills with the TOC above; all internal links resolve; CI green on PRs (build + link check); deploy on merge to main only.
Not blocking #5 — this builds on the docs that PR lands.
The docs directory has grown into a real documentation set — using-skills.md, developing-skills.md, the hands-on evaluation tutorial, plus the design-review and validation records under
reviews/— and it is currently readable only as GitHub blob pages. Converting to MyST with a GitHub Actions deployment gives us a navigable site with QuantEcon-standard tooling, proper cross-references, and math rendering when the framework/tutorial content needs it.Scope
myst.yml) with an explicit TOC: the threedocs/guides, the benchmark user guide, and the evaluation framework. Content stays where it lives — the plugin's files (benchmark/README.md,benchmark/references/EVALUATION_FRAMEWORK.md) are included by the site build, never moved out of the plugin, preserving the self-contained-plugin convention in developing-skills.md.../reviews/..., benchmark README links ablob/mainURL). The conversion should normalize these so they resolve in both contexts, and add a link-check to CI.main; PRs get a build + link-check job (no deploy). Follows the same pattern QuantEcon lecture repos use.Non-goals
Acceptance
quantecon.github.io/skillswith the TOC above; all internal links resolve; CI green on PRs (build + link check); deploy on merge tomainonly.Not blocking #5 — this builds on the docs that PR lands.