Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a documentation section for prerequisite knowledge required to use jrnl #1772

Open
6 tasks
micahellison opened this issue Jul 15, 2023 · 0 comments
Open
6 tasks
Labels
documentation Improvements or additions to documentation 📌 This can't go stale
Milestone

Comments

@micahellison
Copy link
Member

micahellison commented Jul 15, 2023

Affected Page(s)

https://jrnl.sh/en/stable/usage/

What Could Be Better?

We have a few "note" sections about how the specifics of terminal usage affect jrnl, such as mentioning reserved characters' effect on commands. It could be nice to have a section on the specific terminal skills needed to make jrnl work well. Then these notes could be condensed and a link to this section could be added to them.

We don't necessarily have to go into a detail about all these skills, but listing them and linking to related resources could help.

Here's a start:

  • what a terminal is
  • how to run commands with arguments
  • reserved characters on a terminal
  • configuration files
  • piping
  • stdout vs stderr

Other Information

Relates to #1768 but is a much larger scope.

@micahellison micahellison added documentation Improvements or additions to documentation 🆕 New! labels Jul 15, 2023
@micahellison micahellison added 📌 This can't go stale and removed 🆕 New! labels Jul 29, 2023
@micahellison micahellison added this to the Backlog milestone Jul 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 📌 This can't go stale
Projects
None yet
Development

No branches or pull requests

1 participant