Document "Contents"
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 192
- Forks
- 95
- PR merge metrics
- No merged PRs in 30d
Description
Logseq offers "Contents":
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Contents page at https://docs.logseq.com/#/page/contents and review the linked discussions about Contents.md and renaming Contents to Pinboard. Add documentation explaining what Contents is, what users should enter, whether Contents.md must be created manually, and link the help from the contents panel.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100