matrix-org / matrix-org/matrix.org
Restructuring the CONTENT.md
Open
Nobody has claimed this yet.
meta
- Dominant language
- JavaScript
- Stars
- 616
- Forks
- 463
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 19
Description
Some stuff might be worth restructuring. Like the shortcodes mentioned which not only wok in the blog but also for example in the docs may instead be better under a "General" title or similar.
See also: https://github.com/matrix-org/matrix.org/pull/2971#discussion_r2527191976
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 CONTENT.md and read the linked discussion on pull request 2971 for the proposed restructuring. Determine how shortcode references used by both the blog and docs should be grouped, then consider the work done when CONTENT.md has a clear structure that reflects those shared uses.
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
- 35/100