dendronhq / dendron

The personal knowledge management (PKM) tool that grows as you do!
https://wiki.dendron.so
Apache License 2.0
6.69k stars 253 forks source link

Arrange Dendron Wiki information to be lookup friendly. #2994

Open nickolay-kondratyev opened 2 years ago

nickolay-kondratyev commented 2 years ago

Please select if your request is either something new or an enhancement

Please select the area your request applies to. (Multiple selections are Possible. You can leave blank if you're not sure.)

Documentation

Is your feature request related to a problem? Please describe

Hard to find information within Dendron Wiki.

Describe the solution you'd like

Split up heavy notes into distinct sub notes with titles that are look up friendly and then reference with expansion ![[parent-note.subnote1]] from [[parent-note]]

Describe alternatives you've considered

Trying to use ? search but it doesn't work as good as lookup.

Additional context

Not able to easily find something in the wiki that I thought I have seen before. (While someone who isn't aware of that information existence is even less likely to find it).

Dendron has great look-ability functionality, but in the context of the wiki it is very sparsely used, due to notes being quite heavy instead of being split up into sub notes and then linked together using ![[]] syntax.

The example that prompted writing this request is I wanted to find the example of doing sequence diagrams within Dendron. I logged into the wiki and typed sequence into the look up tool, I got 0 results back.

I eventually found something close to this under Markdown note https://wiki.dendron.so/notes/ba97866b-889f-4ac6-86e7-bb2d97f6e376/ (Related to mermaid). For lookability this note can be refactored to use subnotes such as

dendron.topic.markdown.mermaid.flow-chart
dendron.topic.markdown.mermaid.sequence-diagram

Where dendron.topic.markdown.mermaid note can look as:

![[dendron.topic.markdown.mermaid.flow-chart]]
![[dendron.topic.markdown.mermaid.sequence-diagram]]

and dendron.topic.markdown can include the mermaid expanded reference:

![[dendron.topic.markdown.mermaid]]

That way when someone goes into wiki and looks up sequence diagram they will get their answer quickly, while still be able to explore heavy/aggregator parent notes.

kevinslin commented 2 years ago

thanks for the PR. we're actually going to do an update on the docs again to split up in this fashion - will post a followup this week!

kevinslin commented 2 years ago

@nickolay-kondratyev heads up - this is our updated documentation standard > https://handbook.dendron.so/notes/ebpudfrf6rg5uut75d29lhg/

we'll be refactoring all the docs so that features/components are individual notes in lookup