libgit2 / libgit2/www.libgit2.org
Reference documentation for types is a bit odd
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 116
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
There are a few examples where we expose the type details in sys but also have it opaque in the regular public docs. For example, git_credential_username.
In these cases, we don't provide any information about the type in the standard credential docs, only in sys. We should do better.
I would expect to see something here: https://libgit2.org/docs/reference/main/credential/index.html
Instead, I only see it here: https://libgit2.org/docs/reference/main/sys/credential/index.html
When we fix this, we need to update the redirects in libgit2.org/libgit2/index.html to account for it
Contributor guide
No contributing guide indexed for this repository
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
Compare the standard credential reference at libgit2.org/docs/reference/main/credential/index.html with the sys reference, using git_credential_username as the example. Then inspect libgit2.org/libgit2/index.html and update the redirects alongside the reference documentation. Done means the relevant type information appears in the regular credential docs and redirects account for the change.
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
- 45/100