Reorganize docs folder; isolate dev docs and user docs; integrate foam-template docs

[infogulch]

This is a WIP PR to reorganize the docs according to the discussion in #1025.

TODO:

• Finish writing docs/user/index.md
  • Add recipes list
• Merge graph-visualisation.md + graph-visualization.md
• Regenerate all link reference definitions
• Finish centralizing dev docs
• Make sure the site still generates correctly
• Develop and document a repeatable method to transfer user docs into the foam-template repo

[riccardoferretti]

The organization of the docs in user and dev makes a lot of sense to me 👍

Will monitor updates to leave comments as things progress, if you have any question for me feel free to ping!

[infogulch]

I finished the fixups that were apparent to me and everything looks kosher. However, I'm not sure how to validate that the website still generates correctly, and I'm not sure what approach we want to take to automatically syncing over to the foam-template repo.

Thoughts?

[DrakeWhu]

I did a quick review and all seems good, I just suggest adding the graph visualization links in two files where they seem to be missing

[infogulch]

Good callouts, I think the missing links were caused by misspelling "visualization" (with an s instead of a z) which prevented the "link reference definition" feature from auto-generating the links. Besides the ones you found I cleaned up a few other cases as well.

[infogulch]

On a side note, I tried using the "workspace janitor" tool, to redo all the references, but that just made a mess of all the reference sections that it changed. I ended up opening every file individually and saving it a couple times to get the autofix tool to work correctly.

[DrakeWhu]

All seems good now

[DrakeWhu]

I could make sure the site generates correctly. I'm not sure on how to do it but I would be glad to help

[riccardoferretti]

This looks like such a massive improvement of the docs!

[riccardoferretti]

I am thinking of already merging the PR in this state, and take the last point on a separate PR, wdyt?

(re the site, it should work without problems as we still have the index file)

[infogulch]

Yes it absolutely makes sense to merge this now and split the docs-transfer automation into a separate PR.

[riccardoferretti]

@allcontributors add @infogulch for docs

[allcontributors]

@riccardoferretti

I've put up a pull request to add @infogulch! 🎉