Header doc link leads to clay-native, missing api doc index page

未关闭 适合新手
#6 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
88/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
冷清
技术栈
html
领域
documentation

调研方向

打开 content/_layouts/page.ejs 的第 69 行附近,将 header 链接与 content/api-docs/index.md 以及已发布的 /api-docs/ 页面进行比较。更新链接,使 API 文档索引可访问,然后验证 header 会打开预期页面,并且现有的 native-doc 导航不受影响。

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

描述

Current link to api doc in site header leads to "native doc" section

https://github.com/ceramic-engine/ceramic-engine.github.io/blob/main/content/_layouts/page.ejs#L69

making this page https://ceramic-engine.com/api-docs/ | https://github.com/ceramic-engine/ceramic-engine.github.io/blob/main/content/api-docs/index.md "invisible".

Found this trying to get any info about web backend api, ending up searching on github. Search on the api page is scoped to backend, e.g. things related to web backend is not visible on native docs. This is expected but confusing when you dont know that you search the wrong section without any obvious way to open the right doc.

主要语言
HTML
星标
0
派生
4
PR 合并指标
30 天内没有已合并 PR

贡献指南

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

从这里开始

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

ceramic-engine/ceramic-engine.github.io 的其他 Issue

查看 ceramic-engine/ceramic-engine.github.io 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

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