WordPress / WordPress/openverse
Improve documentation homepage
Open
Nobody has claimed this yet.
✨ goal: improvement
📄 aspect: text
🟩 priority: low
🧱 stack: documentation
- Dominant language
- Python
- Stars
- 380
- Forks
- 290
- Avg merge
- 3h 17m
- Merged PRs (30d)
- 8
Description
Problem
Reported by @zackkrida:
This document could use some basic information:
- State what Openverse is and link to openverse.org
- Reference the making wordpress Slack instance and the #openverse channel
- Redundantly share the monorepo link (it's already in the sidebar)
@zackkrida it looks like we already do the first one. Is that note out of date or is there more detail you'd like to see on the landing page regarding what Openverse is.
Description
Address the issues Zack points out above.
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
No file, test, or entry point is named. Start by locating the documentation homepage and compare its current content with the three requested items; done means the homepage clearly explains Openverse, links to openverse.org, references the Making WordPress Slack channel, and includes the monorepo link.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100