logseq / logseq/docs

Suggestion regarding the description of assets in the Logseq DB documentation

Open Beginner friendly
#143 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Clojure
Stars
192
Forks
95
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a documentation file or page, so first locate the section describing assets in the Logseq docs and compare its terminology with the proposed description. Done means the documentation clearly distinguishes asset nodes from actual files, explains the #Asset tag and file actions, and separates asset behavior from internal file links.

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
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.