Link to docs

Open
#868 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
ruby
Domain
documentation

Research direction

Open README.md and review how the main page links to existing references. Add a link to the Rugged::Branch documentation at https://www.rubydoc.info/github/libgit2/rugged/Rugged/Branch; the work is done when readers can reach this reference from the README.

Written by the indexing model from the issue text.

Description

While README.md mostly covers popular use cases, I found that https://www.rubydoc.info/github/libgit2/rugged/Rugged/Branch is still an invaluable reference, which is not linked from the main page. Definitely useful.

Dominant language
C
Stars
2.3k
Forks
293
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 libgit2/rugged

All issues in libgit2/rugged

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.