Reference documentation for types is a bit odd

未关闭
#120 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

将 libgit2.org/docs/reference/main/credential/index.html 中的标准 credential 参考与 sys 参考进行比较，并以 git_credential_username 为例。然后检查 libgit2.org/libgit2/index.html，并更新重定向以及参考文档。相关类型信息出现在常规 credential 文档中，且重定向涵盖此更改，即视为完成。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
CSS
星标
116
派生
67
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

libgit2/www.libgit2.org 的其他 Issue

查看 libgit2/www.libgit2.org 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。