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

オープン 初心者向け
#6 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
88/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
html
領域
documentation

調査の方向性

content/_layouts/page.ejs の 69 行目付近を開き、ヘッダーリンクを content/api-docs/index.md および公開されている /api-docs/ ページと比較します。API ドキュメントのインデックスに到達できるようにリンクを更新し、その後、ヘッダーから期待されるページが開くことと、既存の 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
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ceramic-engine/ceramic-engine.github.io のほかの issue

ceramic-engine/ceramic-engine.github.io の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。