logseq / logseq/docs

Suggestion regarding the description of assets in the Logseq DB documentation

Offen Anfängerfreundlich
#143 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Clojure
Sterne
192
Forks
95
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I think the current asset system is difficult for users to understand because the terminology is somewhat inconsistent. In my opinion, the Logseq documentation should have described assets more appropriately as follows:

asset: A term referring to a special type of node in Logseq. Asset nodes are tagged with the existing built-in tag #Asset, which is hidden from users, so these nodes can be viewed on the #Asset page.
An asset contains two pieces of information: a name and a file. The part that can be freely edited in an asset node is the name. The actual file can be located by right-clicking the node and selecting Show File in Folder
Image and PDF files support built-in rendering, so the files themselves can be displayed directly within Logseq.

Therefore, an asset and an actual file are two different concepts. Linking to a file using ![name](file location) is simply a link to an internal file and has nothing to do with the asset system itself.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Da das Issue keine Dokumentationsdatei oder -seite nennt, finde zuerst den Abschnitt, der Assets in der Logseq-Dokumentation beschreibt, und vergleiche dessen Terminologie mit der vorgeschlagenen Beschreibung. Erledigt ist die Aufgabe, wenn die Dokumentation Asset-Knoten klar von tatsächlichen Dateien unterscheidet, das Tag #Asset und Dateiaktionen erklärt und das Verhalten von Assets von internen Dateilinks trennt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
68/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.