Document "Contents"

Ouverte
#116 0 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Domaine
documentation

Piste de recherche

Commencez par la page Contents à l’adresse https://docs.logseq.com/#/page/contents et consultez les discussions liées au sujet de Contents.md et au renommage de Contents en Pinboard. Ajoutez une documentation expliquant ce qu’est Contents, ce que les utilisateurs doivent saisir, si Contents.md doit être créé manuellement, et ajoutez un lien vers l’aide depuis le panneau Contents.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Logseq offers "Contents":

image

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 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

Langage dominant
Clojure
Étoiles
192
Forks
95
Métriques de merge des PR
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de logseq/docs

Toutes les issues de logseq/docs

Issues similaires

Plus d'issues Clojure

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.