search

ZettelGeist / zettelgeist

A less-is-more (distributed) notetaking application. Designed specifically for those who prefer working with the command line and want to do crazy indexing, analysis, and transformation of notes. Aimed at but not limited to scholarly research projects.
Apache License 2.0
30 stars 5 forks source link

update documentation #16

Closed icornelius closed 4 years ago

icornelius commented 4 years ago

The diff is not useful because I have rewritten these two files end-to-end.

I propose to re-title "Getting Started" as "User's Guide" and make this the primary reference document. In subsequent work I will comb through the tutorials (GDocs, Word, Terminal) and incorporate useful instruction into this document.

For fuller description of changes, see individual commit messages.

The synopses need work. I am learning the conventions for that.

icornelius commented 4 years ago

I suggest retaining either the GDocs or Word Tutorial (the former is now linked from about.md in 8dbf4fa5c0e87936136bb0da4d031d4a68f9cf93) but omitting these two tutorials from page navigation. They have a niche audience (unusual for someone not already writing in plaintext to stumble upon this page and be interested). I expected to find a file navigation.yml where I could make the change, but site navigation is being set somewhere else. Where? I won't have any revisions to the GDocs or Word Tutorials.

gkthiruvathukal commented 4 years ago

I agree with this! We can always focus on Word/GDocs users in a future version of docs. I'd like the focus to be entirely on ZettelGeist and plaintext workflows for now.