Commit graph

9 commits

Author SHA1 Message Date
Micah Jerome Ellison
5b029e6117
Documentation updates (#1032)
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
  Clean up encryption docs
  Clean up security docs
  Delete export.md
  Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
  Update mkdocs config for new files

* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
  This reverts commit 13b4266ed1.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* Doc updates:
- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
2020-10-24 15:41:58 -07:00
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
Micah Jerome Ellison
4df4e56a96 Improve privacy, security, and encryption documentation #896 (#925)
* Improve privacy, security, and encryption documentation #896
* Use gentler language and ensuring documentation does not read like legal advice
2020-05-06 18:14:44 -07:00
Aurélien Ooms
1b3d2961a1 docs: Fix fish history instructions.
Use `--add` flag in fish `abbr` command.
2020-04-10 11:51:56 -07:00
Aurélien Ooms
839ce7d42d Fix typo in encryption docs (#812)
* Explain how fish can be configured to exclude jrnl commands from history by default
* Fix typo in encryption docs
2020-04-10 11:51:56 -07:00
Aurélien Ooms
17ce55e031 Explain how fish can be configured to exclude jrnl commands from history by default 2020-04-10 11:51:56 -07:00
Rory O’Kane
374cae687a In Encryption docs, improve grammar and typography 2020-04-10 11:51:55 -07:00
Greg Bodnar
05234590eb Update docs
Add doc about extracting timestamps with no spaces
Timestamp formats may have no space between date and time components and
cause the script to fail.

In Encryption docs, explain how to prevent Fish history logging
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