docs have no quick "report issue"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
https://docs.pyscript.net/2024.5.2/beginning-pyscript/#indexhtml
It wasn't obvious how to report an issue.
example of goodness
https://f4pga.readthedocs.io/en/latest/getting-started.html
bottom of the page is GitHub https://github.com/chipsalliance/f4pga
which isn't really "log doc issues here" but it's better than nothing. it gets me to a place where I can do something as opposed to "I want to tell someone.. oh well, I give up."
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 the PyScript documentation page at docs.pyscript.net/2024.5.2/beginning-pyscript/#indexhtml and compare its navigation or footer with the linked F4PGA example. Add a clear path for reporting documentation issues, then verify that readers can reach the project’s issue tracker from the page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100