srid / neuron

Future-proof note-taking and publishing based on Zettelkasten (superseded by Emanote: https://github.com/srid/emanote)
https://neuron.zettel.page
GNU Affero General Public License v3.0
1.52k stars 150 forks source link

[DOCS] Explain rationale for lifting subdir notes out of hierarchy #515

Closed flyinggrizzly closed 3 years ago

flyinggrizzly commented 3 years ago

This PR adds documentation for the Directory Tree plugin explaining the rationale behind requiring that directory names be globally unique.

I started with your comment on the last PR, and tried to break it down and give more concrete detail. Hoping this works, and I'm more than happy to make changes to it.

srid commented 3 years ago

@flyinggrizzly This is good. Some comments:

srid commented 3 years ago

Note to self:

flyinggrizzly commented 3 years ago

Hey sorry, I started this earlier today and then my computer died before I pushed 🙃

Still working on it, and I think your feedback is clear and should be easy to work with. I'll ping you when I've had a chance to get back at it (shouldn't be long).

flyinggrizzly commented 3 years ago

Alright--updated. They've gotten longer, though a lot of the length is from the repeated examples with file structures.

One thing worth looking at is the h4 towards the end--it makes sense semantically, but the default styles make it kind of small.

As usual, I'm more than happy to take feedback and make changes, so just let me know.

srid commented 3 years ago

@flyinggrizzly This looks pretty thorough, nice.

We can perfect it after introducing "best practices" section in the docs, and then moving some of the explanation in dirzettel over there as atomic zettels.