Suggestion regarding the description of assets in the Logseq DB documentation
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
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 `` is simply a link to an internal file and has nothing to do with the asset system itself.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
La issue non indica alcun file o pagina della documentazione, quindi individua prima la sezione che descrive gli asset nella documentazione di Logseq e confrontane la terminologia con la descrizione proposta. Il lavoro è completato quando la documentazione distingue chiaramente i nodi asset dai file effettivi, spiega il tag #Asset e le azioni sui file e separa il comportamento degli asset dai collegamenti interni ai file.
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à
- Attiva
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 68/100