"Report" button for documentation
A pull request for this has already been merged.
- #1454 by @mahrud — merged
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
It would be nice to have a report button on the online documentation so people can report issues without going through the trouble of emailing or making a github issue. It would also make it easy to go through a list of reported documentation issues quickly.
For instance, I just found a bug in `width(Net)`, which says:
> For a string, the width and the height are the same.
But this is so minor that even opening an issue seems like an overkill.
Contributor guide
No contributing guide indexed for this repository
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 online documentation context and the `width(Net)` entry mentioned as an example. Check linked pull request #1454 and the existing comment discussion before defining the scope; done would require an agreed reporting workflow that supports collecting and reviewing documentation issues.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100