Foam: Update Documentation for 'Open Daily Note' Feature

Created on 10 Jul 2020  路  4Comments  路  Source: foambubble/foam

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:

  • #54
  • #79
documentation

All 4 comments

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'

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.

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

Looks great to me @riccardoferretti! Thanks @jsjoeio and @juanfrank77 for your input 馃挭馃徎

Was this page helpful?
0 / 5 - 0 ratings

Related issues

WoutV picture WoutV  路  5Comments

jsjoeio picture jsjoeio  路  3Comments

Josh2K picture Josh2K  路  3Comments

fmagin picture fmagin  路  7Comments

amorriscode picture amorriscode  路  6Comments