mirror of
https://github.com/foambubble/foam.git
synced 2026-01-14 00:18:00 -05:00
6b2dda4a71
* fixing some unmatched links, daily-note path note, start graphviz/tags/properties clarification fixed links that didn't actually link to their target, add discussion about creating daily-notes in path based off date, then clarifying notes about styling graph viz and tags while enhancing the note properties descriptions by describing how properties are described and which properties are custom, which are foam-specific, and which are foam-template-specific * add filter view, default variables to graphviz, and viewing tags in graphviz graphviz: discuss filter view, add all changeable variables to graph style example, tags: describe viewing tags in the graphviz * add small note about learning yaml * last push fixing up some todos * making recommended changes from PR request
1021 B
1021 B
Developing documentation
The best way to develop docs for the Foam repo is to directly open the $foam-repo/docs/ as the root folder in a new vscode window.
This automatically configures vscode with the necessary settings enabled (like [link-reference-definitions]) to efficiently write this documentation.
Organization
The Foam documentation is organized into two areas:
- User docs, located at
$foam-repo/docs/user/*, which are copied in their entirety into$foam-template-repo/docs. - Developer docs, located at
$foam-repo/docs/dev/*
New user docs should be added to the User docs folder in the main Foam repo, then copied over to the Foam Template repo.
[todo]: Automate this process. Idea: github action to open a PR on any change to
/docs/user