Update docs to include live examples
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
See @JeffersGlass's and @leriomaggio's awesome talks about this.
We should dogfood this in our docs, and also explain how to do it in our docs.
Since we're using mkdocs, I believe the mkdocs-pyscript plugin is what we need.
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 by reviewing the existing documentation structure and the referenced talks, then verify how the mkdocs-pyscript plugin fits the current docs setup. Done means the docs include live examples and explain how readers can create them using the plugin; the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100