logseq / logseq/docs

Document "Contents"

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

还没有人认领这个 Issue。

主要语言
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 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 摘要。