Documentation updates #1032

micahellison · 2020-08-22T20:04:02Z

Goals for this pr:

Apply changes from reviews of previous doc PRs - added note that pycrypto is required #980, ongoing changes to overview.md #981, updated README.md #982
Ensure that documentation is completely aligned with jrnl --help now that Clean up help screen, get rid of util.py #1027 is merged

Checklist

I have read the contributing doc.
I have included a link to the relevant issue number.
I have tested this code locally.
I have checked to ensure there aren't other open pull requests
for the same issue.
I have written new tests for these changes, as needed.
All tests pass.

docs/overview.md

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

…t more concise

… for 3.9

…t needed for 3.9" This reverts commit 13b4266.

docs/import-and-export.md

docs/security.md

docs/encryption.md

docs/recipes.md

mkdocs.yml

wren

This is looking fantastic. Just a few minor nitpicks, and I think we're good to go.

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>

- 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

wren

🤠

Applying doc changes based on reviews of past several documentation PRs

353b3d9

wren reviewed Aug 29, 2020

View reviewed changes

docs/overview.md Outdated Show resolved Hide resolved

wren and others added 5 commits August 29, 2020 19:46

Update docs

4dbe453

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

e28cf1d

Correct incomplete sentences and markdown formatting issues

bc7a2cb

Make overview a little more concise

6d5ea75

Update some command line arguments to latest version and make it a bi…

30b6bc8

…t more concise

micahellison changed the title ~~Documentation updates [WIP]~~ Documentation updates Oct 10, 2020

micahellison marked this pull request as ready for review October 10, 2020 22:42

micahellison requested a review from wren October 10, 2020 22:46

micahellison added 3 commits October 10, 2020 15:59

Clean up unneeded TOML modifications and other scaffolding not needed…

13b4266

… for 3.9

Revert "Clean up unneeded TOML modifications and other scaffolding no…

7a71109

…t needed for 3.9" This reverts commit 13b4266.

Specify that brew is also the easiest way to install jrnl on Linux

d2cc176

wren force-pushed the develop branch 4 times, most recently from d69ab33 to 8c2de0e Compare October 18, 2020 02:04