support comments in rust documentation
Open
Nobody has claimed this yet.
T-community
T-doc
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 1.7k
- Avg merge
- 16h 14m
- Merged PRs (30d)
- 1
Description
I'm not sure if this is feasible or even a good idea but this haskell documentation page has inline expandable comments by the readers. This could be a good thing to support. I do like it on the haskell page but I'm not sure if I would here.
Good things it would allow:
- readers to ask questions at the direct problem location
- people to add pertinent info to examples as they will
- this could direct authors to how the docs need improvement
Bad things:
- probably would require moderators or approval of comments
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
Review the linked Real World Haskell documentation page to understand the proposed inline expandable comments. Then assess the reader-question, supplemental-information, documentation-feedback, and moderation concerns described here. Done would require a decided scope and an agreed approach for comments and approval.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100