logseq / logseq/docs

Document "Contents"

Aperta
#116 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Clojure
Stelle
192
Fork
95
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla pagina Contents all’indirizzo https://docs.logseq.com/#/page/contents e rivedi le discussioni collegate su Contents.md e sulla ridenominazione di Contents in Pinboard. Aggiungi una documentazione che spieghi cos’è Contents, cosa devono inserire gli utenti, se Contents.md deve essere creato manualmente e collega la guida dal pannello Contents.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.