readthedocs / readthedocs/website
Content: add a page for a gallery, to show off some examples of documenation
Open
Nobody has claimed this yet.
Improvement
- Dominant language
- HTML
- Stars
- 21
- Forks
- 10
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 8
Description
This is a common request, and something that we've accumulated in a few various places. It would be great to show off what user generated documentation can look like. Here's a good example:
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 Quarto gallery example and identify the existing places where user-generated documentation examples have accumulated. Define the gallery page's example set and presentation, then confirm that the new page is published and showcases representative user-generated documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100