libgit2 / libgit2/libgit2

for-each-ref.c example page is broken

Open
#4,084 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
10.6k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

Reproduction steps

Go on the documentation page https://libgit2.github.com/libgit2/#HEAD
Click on the link to for-each-ref.c example page. This is the direct url https://libgit2.github.com/libgit2/ex/HEAD/for-each-ref.html

Expected behavior
Actual behavior

The page is almost empty.
Other pages are fine.

Version of libgit2 (release number or SHA1)

HEAD

Operating system(s) tested

Doesn't seem to be browser related, I tested on firefox and chrome

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.

Research direction

Start with the documentation page and the direct for-each-ref.c example URL, then compare them with a working example page. Trace how this example is published and verify that the link opens a page containing the expected example content.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.