Use main branch for doc references

Open
#275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
git
Domain
documentation

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.

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

Dominant language
TypeScript
Stars
2
Forks
2
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from simenandre/pubsub-http-handler

All issues in simenandre/pubsub-http-handler

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.