Commit graph

5 commits

Author SHA1 Message Date
Jonathan Wren
29234ddc35
Documentation updates (Thanks @guydebros!) (#1031)
* updated README.md:

- corrected information about encryption
- made additions based on proposed changes to overview.md
- made other changes for clarity and grammar

* ongoing changes to overview.md

* added note that `pycrypto` is required

made other small changes for grammar and clarity

* added new python decryption script to encryption.md

* updated encryption.md to clarify dependencies

other relatively small changes for clarity

straightened quotes

Co-authored-by: Guy B. deBros <guydebros@users.noreply.github.com>
2020-08-22 12:13:36 -07:00
Guy B. deBros
ca73c74a8e Extensive modifications to overview.md (#957)
* Extensive modifications to overview.md.

I tried to add clarity and details while maintaining the spirit of the original
document. However, it might be a bit too 'dry' now. I'd be happy to liven it up
a bit. I'm only serious when I feel like I _have_ to be.

One of my opinions (which may be at odds with yours) is that the documentation
should emphasize `jrnl`'s advantages without downplaying any other existing
solutions.

If I have time, I'd like to add more information about the documented benefits
of journaling, particularly the mental health aspects. That will probably need
its own page, but I'm new here, so I don't want to overstay my welcome. :)

* More changes to overview.md in response to feedback

"why keep a journal" section removed -- it could be re-added as its own page,
but it's not front-page material

* More changes to overview.md:
- fixed up the headings
- added information about multi-platform support

This is a work in progress and _not_ ready for prime-time.
- need to add to Command-Line Interface section, among other things

* More changes to overview.md:

- moved "`jrnl` is a simple..." to "Command-Line Interface" section
2020-06-06 12:43:28 -07:00
Micah Jerome Ellison
47310f71a1 [GH-666] updating documentation to reflect v2 behavior:
* new config location and file type
* removing mentions of DayOne support
* removing mention of pip install jrnl[encrypted]
2020-04-10 11:51:55 -07:00
Manuel Ebert
328faa401c Smaller doc fixes, fixes #486
Found and removed another angsty teenager
2020-04-10 11:51:55 -07:00
Manuel Ebert
b7e077be68 Moving from sphinx to mkdocs
Cleaning up docs
Lighter side bar
Landing page refresh
Add JSON-LD and semantic tags
2020-04-10 11:51:55 -07:00