Reference documentation for types is a bit odd

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

Nobody has claimed this yet.

Assessment

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

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.

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

Dominant language
CSS
Stars
116
Forks
67
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/www.libgit2.org

All issues in libgit2/www.libgit2.org

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.