QuantEcon / QuantEcon/quantecon-plugins.mystmd
Docs per directive, default-theme fallback proof, v0.1.0 release
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 2h 52m
- Merged PRs (30d)
- 7
Description
Part of #2 (Phase 1a).
Problem. The family is only usable beyond QuantEcon if a stranger can find a directive, read its options, pin the bundle and see the plain fallback work in a default theme. The lecture theme's release flow (release.yml at 47e37ed8) is the pattern: a tag that must match package.json, release notes from the changelog section, assets attached to the GitHub Release.
Proposed work.
- README per directive under
docs/, each with the option table, an inline-data example, a:file:example, and a screenshot of the plain fallback in the default book theme. - A demo project under
examples/that a reader can run withmyst start. release.yml: tag-triggered, version guard, changelog-section guard, attachesdist/datavis.mjs;CHANGELOG.mdin Keep-a-Changelog form.v0.1.0cut once the eight directives and the contract are merged;v0.xthereafter tracks the report theme's needs until the contract freezes.
Acceptance criteria.
-
v0.1.0release exists withdatavis.mjsattached and notes from the changelog - Pinning that URL in a fresh mystmd project renders every example as plain tables and lists in the default theme
- Every directive has a docs page; the README links them
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/, examples/, release.yml, CHANGELOG.md, and the release workflow at 47e37ed8. Run the examples with myst start and verify a fresh mystmd project renders each directive as plain tables or lists in the default theme. Done means every directive is documented, README links the pages, and the v0.1.0 GitHub Release contains datavis.mjs with changelog notes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, javascript, markdown
- Domain
- build-system, documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100