Problems with syncing overiew and readme
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 361
- Forks
- 159
- PR merge metrics
- No merged PRs in 30d
Description
The current implementation of the docs requires the README to be synced with /docs/overview.md. It's very easy to forget to sync both documents so that should be solved somehow. I suggest that we can default to /docs/README.md that way GitHub will still display the README at root according to https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
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 by inspecting how README and /docs/overview.md are currently synchronized, then review the repository's documentation setup and GitHub's README selection behavior. Confirm whether /docs/README.md can become the maintained entry point and verify that the rendered repository README stays correct without duplicating content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100