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

Update Documentation for 'Open Daily Note' Feature #87

Closed
jsjoeio opened this issue Jul 10, 2020 · 4 comments
Closed

Update Documentation for 'Open Daily Note' Feature #87

jsjoeio opened this issue Jul 10, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@jsjoeio
Copy link
Contributor

jsjoeio commented Jul 10, 2020

Things we should document for this new feature:

  • what it is
  • how to change the Filename format
  • how to change the File extension
  • how to change the Title format of the daily note
  • how to set the Daily notes directory

Questions:

Based on how the docs are set up, my best guess is this would fall under a Recipe. Curious to hear thoughts from @jevakallio

Related:

@jsjoeio jsjoeio added the documentation Improvements or additions to documentation label Jul 10, 2020
@juanfrank77
Copy link
Contributor

Hey guys!

Just throwing some ideas here.

  • Would it be good to have a dedicated section for the note's settings on the VS Code UI so that people could change them there instead of going to the .vscode/settings.json?
  • Make the documentation as clear as possible so that a non-dev person would know where to go and what options to enable/disable according to preference.

I think that once is completed, removing it from the roadmap and also the implementation page would be a good idea (unless the intention is to let it there as a reminder of how far the project has gone 😉).

Also agree that I would be better being a Recipe under the 'write' category. Maybe something like 'Configure your daily notes'

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Jul 11, 2020

Would it be good to have a dedicated section for the note's settings on the VS Code UI so that people could change them there instead of going to the .vscode/settings.json?

Good idea! You can use the Settings UI with how it's implemented right now. Here's what it will look like.

image

But if we find it hard for non-devs, we can always brainstorm how to improve the UX. For v1, this seems like it should get the job done.

Make the documentation as clear as possible so that a non-dev person would know where to go and what options to enable/disable according to preference.

Agreed! Definitely something we want to keep in mind.

Thanks for adding your input! 🙏🏼 Really helpful to have a second opinion.

@riccardoferretti
Copy link
Collaborator

@ingalless I believe this has now been sorted, can you double check and close the issue if that's the case? thanks!

@ingalless
Copy link
Member

Looks great to me @riccardoferretti! Thanks @jsjoeio and @juanfrank77 for your input 💪🏻

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
Projects
None yet
Development

No branches or pull requests

4 participants