simenandre / simenandre/pubsub-http-handler
Use main branch for doc references
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
We currently maintain links that refer to git commits in our documentation. There might be a point in using branch reference instead? I.e. main
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
Review the documentation links that currently point to git commits and compare them with the main branch reference proposed in the issue. Confirm which links should use main and verify that the updated documentation resolves correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100