logseq / logseq/docs

Document "Contents"

オープン
#116 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る

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

主要言語
Clojure
スター
192
フォーク
95
PR マージ指標
30日以内にマージされた PR はありません

説明

Logseq offers "Contents":

![image](https://github.com/logseq/docs/assets/1366654/3c15214a-eba0-4ebe-b209-37a2c71a24e0)

If I do Ctrl+F in https://docs.logseq.com/#/page/contents, I don't find a help on "Contents".

First, I thought, this would be auto-generated, because I was thinking of it as short form of "table of contents" or a variant of "outline". However, I can type into. What am I supposed to type into?

It would be OK to add a dummy page linking to https://discuss.logseq.com/t/what-is-the-contents-md-page/8869.

In call cases, the help page should be linked from the contents panel.

Following [comment by alex0](https://discuss.logseq.com/t/rename-contents-to-pinboard/8895/10) should also be explained:

> I use Contents.md as table of contents like in other applications.

Does one need to generate a `Contents.md` manually?

---

Maybe I should stress https://discuss.logseq.com/t/rename-contents-to-pinboard/8895:

> Rename Contents to Pinboard

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

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

はじめの一歩

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

調査の方向性

https://docs.logseq.com/#/page/contents の Contents ページから始め、Contents.md と Contents の Pinboard への名称変更についてのリンクされた議論を確認してください。Contents とは何か、ユーザーが何を入力すべきか、Contents.md を手動で作成する必要があるかを説明するドキュメントを追加し、contents パネルからヘルプにリンクしてください。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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