Docs sync @ 52b7f86 Updated TOC in FAQ docs (#49)

docs/tools/cli.md

@@ -0,0 +1,10 @@
+# Command Line Interface
+
+Create a CLI tool to allow running common Foam commands. These may include:
+
+- `foam init` - create a new foam workspace
+- `foam janitor` - run [[workspace-janitor]] in current workspace
+- `foam migrate <tool>` - migrate from tools like roam exports, obsidian and more
+
+More commands to be added.
+

docs/tools/foam-logging-in-vscode.md

@@ -0,0 +1,20 @@
+# Foam logging in VsCode
+
+The Foam extension logs details about what its doing in vscode's `Output` tab.
+Generally this is only useful if you're reporting an issue about Foam.
+
+1. To show the tab, click on `View > Output`.
+2. In the dropdown on the right of the tab, select `Foam`.
+
+![Find the foam log](../../assets/images/foam-log.png)
+
+When reporting an issue about Foam, set the log level to `Debug`:
+
+## Change the log level for the session
+
+Execute the command `Foam: Set log level`.
+
+## Change the default logging level
+
+1. Open workspace settings (`cmd+,`, or execute the `Preferences: Open Workspace Settings` command)
+2. Look for the entry `Foam > Logging: Level`

docs/tools/orphans.md

@@ -0,0 +1,10 @@
+# Orphaned Notes
+
+Foam helps you to find orphans: notes that have neither forward links nor backlinks.
+
+Orphans can be found in the Orphans panel.
+
+Two settings allows you to control the behaviour of the Orphans panel:
+
+- `foam.orphans.exclude`: list of glob patterns that will be used to exclude directories. For example, a value of `["journal/**/*"]` would exclude your daily notes.
+- `foam.orphans.groupBy`: sets the default view mode of the Orphans panel: either groups by folder (by default), or lists all orphans. The view can be toggled on the fly from the panel, but it won't overwrite the setting.

docs/tools/workspace-janitor.md

@@ -0,0 +1,38 @@
+# Janitor
+
+To store your personal knowledge graph in markdown files instead of a database, we need some additional tooling to create and maintain relationships with notes.
+
+**Foam Janitor** (inspired by Andy Matuschak's [note-link-janitor](https://github.com/andymatuschak/note-link-janitor)) helps you migrate existing notes to Foam, and maintain your Foam's health over time.
+
+Currently, Foam's Janitor helps you to:
+
+- Ensure your [[link-reference-definitions]] are up to date
+- Ensure every document has a well-formatted title (required for Markdown Links, Markdown Notes, and Foam Gatsby Template compatibility)
+
+In the future, Janitor can help you with
+
+- Updating [[materialized-backlinks]]
+- Lint, format and structure notes
+- Rename and move notes around while keeping their references up to date.
+
+## Using Janitor from VS Code (Experimental)
+
+Execute the "Foam: Run Janitor" command from the command palette.
+
+![Foam Janitor demo](../../assets/images/foam-janitor-demo.gif)
+
+## Using Janitor from command line (Experimental)
+
+> ⚠️ Improvements to this documentation are welcome!
+
+The Janitor can be installed from [NPM](https://www.npmjs.com/) and executed as a standalone CLI tool:
+
+```sh
+> npm install -g foam-cli
+> foam janitor path/to/workspace
+```
+
+You can run the Janitor as a git hook on every commit to ensure your workspace links are up to date. This can be especially helpful if you edit your markdown documents from other apps.
+
+You can also run the Janitor from a GitHub action to ensure that all changes coming to your workspace are up to date. This can be useful when editing your Foam notes from mobile (i.e. via [GitJournal](https://gitjournal.io)), or your Foam has multiple contributors and you want to ensure that all changes are correctly integrated.
+