v0.29.0

* Support for links with references

* wikilink also use references

* Removed [[//begin]] and [[//end]] definitions from code and documentation

.all-contributorsrc

@@ -424,7 +424,8 @@
       "avatar_url": "https://avatars2.githubusercontent.com/u/15343819?v=4",
       "profile": "http://jmg-duarte.github.io",
       "contributions": [
-        "code"
+        "code",
+        "doc"
       ]
     },
     {
@@ -525,8 +526,667 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "MCluck90",
+      "name": "Mike Cluck",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1753801?v=4",
+      "profile": "https://mcluck.tech",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "bpugh",
+      "name": "Brandon Pugh",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/684781?v=4",
+      "profile": "http://brandonpugh.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "themaxdavitt",
+      "name": "Max Davitt",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/27709025?v=4",
+      "profile": "https://max.davitt.me",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "anglinb",
+      "name": "Brian Anglin",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/2637602?v=4",
+      "profile": "http://briananglin.me",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "elswork",
+      "name": "elswork",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1455507?v=4",
+      "profile": "http://deft.work",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "leonhfr",
+      "name": "léon h",
+      "avatar_url": "https://avatars.githubusercontent.com/u/19996318?v=4",
+      "profile": "http://leonh.fr/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "njnygaard",
+      "name": "Nikhil Nygaard",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4606342?v=4",
+      "profile": "https://nygaard.site",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "nitwit-se",
+      "name": "Mark Dixon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1382124?v=4",
+      "profile": "http://www.nitwit.se",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "joeltjames",
+      "name": "Joel James",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3732400?v=4",
+      "profile": "https://github.com/joeltjames",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "ryo33",
+      "name": "Hashiguchi Ryo",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8780513?v=4",
+      "profile": "https://www.ryo33.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "movermeyer",
+      "name": "Michael Overmeyer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1459385?v=4",
+      "profile": "https://movermeyer.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "derrickqin",
+      "name": "Derrick Qin",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3038111?v=4",
+      "profile": "https://github.com/derrickqin",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "zomars",
+      "name": "Omar López",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3504472?v=4",
+      "profile": "https://www.linkedin.com/in/zomars/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "RobinKing",
+      "name": "Robin King",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1583193?v=4",
+      "profile": "http://robincn.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "dheepakg",
+      "name": "Dheepak ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4730170?v=4",
+      "profile": "http://twitter.com/deegovee",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "daniel-vera-g",
+      "name": "Daniel VG",
+      "avatar_url": "https://avatars.githubusercontent.com/u/28257108?v=4",
+      "profile": "https://github.com/daniel-vera-g",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Barabazs",
+      "name": "Barabas",
+      "avatar_url": "https://avatars.githubusercontent.com/u/31799121?v=4",
+      "profile": "https://github.com/Barabazs",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "EngincanV",
+      "name": "Engincan VESKE",
+      "avatar_url": "https://avatars.githubusercontent.com/u/43685404?v=4",
+      "profile": "http://enginveske@gmail.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "pderaaij",
+      "name": "Paul de Raaij",
+      "avatar_url": "https://avatars.githubusercontent.com/u/495374?v=4",
+      "profile": "http://www.paulderaaij.nl",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "bronson",
+      "name": "Scott Bronson",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1776?v=4",
+      "profile": "https://github.com/bronson",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "rafo",
+      "name": "Rafael Riedel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41793?v=4",
+      "profile": "http://rafaelriedel.de",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Pearcekieser",
+      "name": "Pearcekieser",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5055971?v=4",
+      "profile": "https://github.com/Pearcekieser",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "theowenyoung",
+      "name": "Owen Young",
+      "avatar_url": "https://avatars.githubusercontent.com/u/62473795?v=4",
+      "profile": "https://github.com/theowenyoung",
+      "contributions": [
+        "doc",
+        "content"
+      ]
+    },
+    {
+      "login": "ksprashu",
+      "name": "Prashanth Subrahmanyam",
+      "avatar_url": "https://avatars.githubusercontent.com/u/476729?v=4",
+      "profile": "http://www.prashu.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "JonasSprenger",
+      "name": "Jonas SPRENGER",
+      "avatar_url": "https://avatars.githubusercontent.com/u/25108895?v=4",
+      "profile": "https://github.com/JonasSprenger",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Laptop765",
+      "name": "Paul",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1468359?v=4",
+      "profile": "https://github.com/Laptop765",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "eltociear",
+      "name": "Ikko Ashimine",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22633385?v=4",
+      "profile": "https://bandism.net/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "memeplex",
+      "name": "memeplex",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2845433?v=4",
+      "profile": "https://github.com/memeplex",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "AndreiD049",
+      "name": "AndreiD049",
+      "avatar_url": "https://avatars.githubusercontent.com/u/52671223?v=4",
+      "profile": "https://github.com/AndreiD049",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "iam-yan",
+      "name": "Yan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48427014?v=4",
+      "profile": "https://github.com/iam-yan",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "jimt",
+      "name": "Jim Tittsler",
+      "avatar_url": "https://avatars.githubusercontent.com/u/180326?v=4",
+      "profile": "https://WikiEducator.org/User:JimTittsler",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "MalcolmMielle",
+      "name": "Malcolm Mielle",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4457840?v=4",
+      "profile": "http://malcolmmielle.wordpress.com/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "veesar",
+      "name": "Veesar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/74916913?v=4",
+      "profile": "https://snippets.page/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "bentongxyz",
+      "name": "bentongxyz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/60358804?v=4",
+      "profile": "https://github.com/bentongxyz",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "techCarpenter",
+      "name": "Brian DeVries",
+      "avatar_url": "https://avatars.githubusercontent.com/u/42778030?v=4",
+      "profile": "https://brianjdevries.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "cliffordfajardo",
+      "name": "Clifford Fajardo ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6743796?v=4",
+      "profile": "http://Cliffordfajardo.com",
+      "contributions": [
+        "tool"
+      ]
+    },
+    {
+      "login": "chrisUsick",
+      "name": "Chris Usick",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6589365?v=4",
+      "profile": "http://cu-dev.ca",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "josephdecock",
+      "name": "Joe DeCock",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1145533?v=4",
+      "profile": "https://github.com/josephdecock",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "drewtyler",
+      "name": "Drew Tyler",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5640816?v=4",
+      "profile": "http://www.drewtyler.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Lauviah0622",
+      "name": "Lauviah0622",
+      "avatar_url": "https://avatars.githubusercontent.com/u/43416399?v=4",
+      "profile": "https://github.com/Lauviah0622",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "joshdover",
+      "name": "Josh Dover",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1813008?v=4",
+      "profile": "https://www.elastic.co/elastic-agent",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "phelma",
+      "name": "Phil Helm",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4057948?v=4",
+      "profile": "http://phelm.co.uk",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "lingyv-li",
+      "name": "Larry Li",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8937944?v=4",
+      "profile": "https://github.com/lingyv-li",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "infogulch",
+      "name": "Joe Taber",
+      "avatar_url": "https://avatars.githubusercontent.com/u/133882?v=4",
+      "profile": "https://github.com/infogulch",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "readingsnail",
+      "name": "Woosuk Park",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1904967?v=4",
+      "profile": "https://www.readingsnail.pe.kr",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "dmurph",
+      "name": "Daniel Murphy",
+      "avatar_url": "https://avatars.githubusercontent.com/u/294026?v=4",
+      "profile": "http://www.dmurph.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Dominic-DallOsto",
+      "name": "Dominic D",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26859884?v=4",
+      "profile": "https://github.com/Dominic-DallOsto",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "elgirafo",
+      "name": "luca",
+      "avatar_url": "https://avatars.githubusercontent.com/u/80516439?v=4",
+      "profile": "http://elgirafo.xyz",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Lloyd-Jackman-UKPL",
+      "name": "Lloyd Jackman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/55206370?v=4",
+      "profile": "https://github.com/Lloyd-Jackman-UKPL",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "sn3akiwhizper",
+      "name": "sn3akiwhizper",
+      "avatar_url": "https://avatars.githubusercontent.com/u/102705294?v=4",
+      "profile": "http://sn3akiwhizper.github.io",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "jonathanpberger",
+      "name": "jonathan berger",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41085?v=4",
+      "profile": "http://jonathanpberger.com/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "badsketch",
+      "name": "Daniel Wang",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8953212?v=4",
+      "profile": "https://github.com/badsketch",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "tlylt",
+      "name": "Liu YongLiang",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41845017?v=4",
+      "profile": "http://yongliangliu.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Skakerman",
+      "name": "Scott Akerman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/15224439?v=4",
+      "profile": "http://scottakerman.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "jimgraham",
+      "name": "Jim Graham",
+      "avatar_url": "https://avatars.githubusercontent.com/u/430293?v=4",
+      "profile": "http://www.jim-graham.net/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "hezhizhen",
+      "name": "Zhizhen He",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7611700?v=4",
+      "profile": "https://t.me/littlepoint",
+      "contributions": [
+        "tool"
+      ]
+    },
+    {
+      "login": "tcheneau",
+      "name": "Tony Cheneau",
+      "avatar_url": "https://avatars.githubusercontent.com/u/952059?v=4",
+      "profile": "https://amnesiak.org/me",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "nicholas-l",
+      "name": "Nicholas Latham",
+      "avatar_url": "https://avatars.githubusercontent.com/u/12977174?v=4",
+      "profile": "https://github.com/nicholas-l",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "thara",
+      "name": "Tomochika Hara",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1532891?v=4",
+      "profile": "https://thara.dev",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "dcarosone",
+      "name": "Daniel Carosone",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11495017?v=4",
+      "profile": "https://github.com/dcarosone",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "MABruni",
+      "name": "Miguel Angel Bruni Montero",
+      "avatar_url": "https://avatars.githubusercontent.com/u/100445384?v=4",
+      "profile": "https://github.com/MABruni",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Walshkev",
+      "name": "Kevin Walsh ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/77123083?v=4",
+      "profile": "https://github.com/Walshkev",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "hereistheusername",
+      "name": "Xinglan Liu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/33437051?v=4",
+      "profile": "http://hereistheusername.github.io/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Hegghammer",
+      "name": "Thomas Hegghammer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/64712218?v=4",
+      "profile": "http://www.hegghammer.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "PiotrAleksander",
+      "name": "Piotr Mrzygłosz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6314591?v=4",
+      "profile": "https://github.com/PiotrAleksander",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "markschaver",
+      "name": "Mark Schaver",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7584?v=4",
+      "profile": "http://schaver.com/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "n8layman",
+      "name": "Nathan Layman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/25353944?v=4",
+      "profile": "https://github.com/n8layman",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "emmanuel-ferdman",
+      "name": "Emmanuel Ferdman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/35470921?v=4",
+      "profile": "https://github.com/emmanuel-ferdman",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Tenormis",
+      "name": "Tenormis",
+      "avatar_url": "https://avatars.githubusercontent.com/u/61572102?v=4",
+      "profile": "https://github.com/Tenormis",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "djplaner",
+      "name": "David Jones",
+      "avatar_url": "https://avatars.githubusercontent.com/u/225052?v=4",
+      "profile": "http://djon.es/blog",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "s-jacob-powell",
+      "name": "S. Jacob Powell",
+      "avatar_url": "https://avatars.githubusercontent.com/u/109111499?v=4",
+      "profile": "https://github.com/s-jacob-powell",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "figdavi",
+      "name": "Davi Figueiredo",
+      "avatar_url": "https://avatars.githubusercontent.com/u/99026991?v=4",
+      "profile": "https://github.com/figdavi",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "ChThH",
+      "name": "CT Hall",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9499483?v=4",
+      "profile": "https://github.com/ChThH",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,
-  "skipCi": true
+  "skipCi": true,
+  "commitType": "docs"
 }

.claude/commands/research-issue.md

@@ -0,0 +1,61 @@
+# Research Issue Command
+
+Research a GitHub issue by analyzing the issue details and codebase to generate a comprehensive task analysis file.
+
+## Usage
+
+```
+/research-issue <issue-number>
+```
+
+## Parameters
+
+- `issue-number` (required): The GitHub issue number to research
+
+## Description
+
+This command performs comprehensive research on a GitHub issue by:
+
+1. **Fetching Issue Details**: Uses `gh issue view` to get issue title, description, labels, comments, and related information
+2. **Codebase Analysis**: Searches the codebase for relevant files, patterns, and components mentioned in the issue
+3. **Root Cause Analysis**: Identifies possible technical causes based on the issue description and codebase findings
+4. **Solution Planning**: Proposes two solution approaches ranked by preference
+5. **Documentation**: Creates a structured task file in `.agent/tasks/<issue-id>-<sanitized-title>.md`
+
+If there is already a `.agent/tasks/<issue-id>-<sanitized-title>.md` file, use it for context and update it accordingly.
+If at any time during these steps you need clarifying information from me, please ask.
+
+## Output Format
+
+Creates a markdown file with:
+
+- Issue summary and key details
+- Research findings from codebase analysis
+- Identified possible root causes
+- Two ranked solution approaches with pros/cons
+- Technical considerations and dependencies
+
+## Examples
+
+```
+/research-issue 1234
+/research-issue 567
+```
+
+## Implementation
+
+The command will:
+
+1. Validate the issue number and check if it exists
+2. Fetch issue details using GitHub CLI
+3. Search codebase for relevant patterns, files, and components
+4. Analyze findings to identify root causes
+5. Generate structured markdown file with research results
+6. Save to `.agent/tasks/` directory with standardized naming
+
+## Error Handling
+
+- Invalid issue numbers
+- GitHub CLI authentication issues
+- Network connectivity problems
+- File system write permissions

.devcontainer/devcontainer.json

@@ -0,0 +1,10 @@
+{
+  "name": "Foam Dev Container",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:0-18",
+  "postCreateCommand": "yarn install",
+  "customizations": {
+    "vscode": {
+      "extensions": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+    }
+  }
+}

.eslintrc.json

@@ -0,0 +1,61 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "env": { "node": true, "es6": true },
+  "plugins": ["jest"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:import/typescript",
+    "plugin:jest/recommended"
+  ],
+  "rules": {
+    "no-redeclare": "off",
+    "no-unused-vars": "off",
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "@typescript-eslint/no-unused-vars": "warn",
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": ["**/src/test/**", "**/src/**/*{test,spec}.ts"]
+      }
+    ]
+  },
+  "overrides": [
+    {
+      // Restrict usage of fs module outside tests to keep foam compatible with the browser
+      "files": ["**/src/**"],
+      "excludedFiles": ["**/src/test/**", "**/src/**/*{test,spec}.ts"],
+      "rules": {
+        "no-restricted-imports": [
+          "error",
+          {
+            "name": "fs",
+            "message": "Extension code must not rely Node.js filesystem, use vscode.workspace.fs instead."
+          }
+        ]
+      }
+    }
+  ],
+  "settings": {
+    "import/core-modules": ["vscode"],
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"]
+    },
+    "import/resolver": {
+      "typescript": {
+        "alwaysTryTypes": true
+      }
+    }
+  },
+  "ignorePatterns": ["**/core/common/**", "*.js"],
+  "reportUnusedDisableDirectives": true
+}

.github/CONTRIBUTING.md

@@ -1,14 +0,0 @@
-# Contributing
-
-Hello, friend.
-
-This repository is a [monorepo](https://en.wikipedia.org/wiki/Monorepo) managed by [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
-
-- The [packages](packages/) directory contains all Foam core code packages
-- The [docs](docs/) directory contains a Foam workspace that hosts the official [documentation site](https://foambubble.github.io/foam)
-
-The foam starter template lives outside of this repository at [foambubble/foam-template](https://github.com/foambubble/foam-template).
-
-See [Foam Contribution Guide](https://foambubble.github.io/foam/contribution-guide) on the rendered Foam workspace for more information on how to contribute to Foam.
-
-Thank you for your interest!

.github/ISSUE_TEMPLATE/bug.md

@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us be foamier
-labels: bug, awaiting triage
-title: [BUG]
----
-
-**Describe the bug**
-<!-- A clear and concise description of what the bug is.-->
-
-**Affected package**
-<!-- Its ok if you don't know! -->
-- [ ] `foam-cli`
-- [ ] `foam-core`
-- [ ] `foam-vscode`
-- [ ] `other/meta/???`
-
-**To Reproduce**
-<!-- Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error -->
-
-**Expected behavior**
-<!-- A clear and concise description of what you expected to happen. -->
-
-**Screenshots**
-<!-- If applicable, add screenshots to help explain your problem. -->
-
-**Additional context**
-<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,97 @@
+name: 'Bug report'
+description: Create a report to help us improve
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue :pray:.
+
+        This issue tracker is for reporting bugs found in `foam` (https://github.com/foambubble).
+        If you have a question about how to achieve something and are struggling, please post a question
+        inside of either of the following places:
+          - Foam's Discussion's tab: https://github.com/foambubble/foam/discussions
+          - Foam's Discord channel: https://foambubble.github.io/join-discord/g
+          
+
+        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
+         - Foam's Issue's tab: https://github.com/foambubble/foam/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
+         - Foam's closed issues tab: https://github.com/foambubble/foam/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
+         - Foam's Discussions tab: https://github.com/foambubble/foam/discussions
+
+        The more information you fill in, the better the community can help you.
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of the challenge you are running into.
+    validations:
+      required: true
+  - type: input
+    id: reproducible_example
+    attributes:
+      label: Small Reproducible Example
+      description: |
+        Note:
+        - Your bug will may get fixed much faster if there is a way we can somehow run your example or code.
+        - To create a shareable example, consider cloning the following Foam Github template: https://github.com/foambubble/foam-template
+        - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
+      placeholder: |
+        e.g. Link to your github repository containing a small reproducible example that the team can run.
+    validations:
+      required: false
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce the Bug or Issue
+      description: Describe the steps we have to take to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: Provide a clear and concise description of what you expected to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but i am seeing ___
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots_or_videos
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓
+  - type: input
+    id: os
+    attributes:
+      label: Operating System Version
+      description: What operating system are you using?
+      placeholder: |
+        - OS: [e.g. macOS, Windows, Linux]
+    validations:
+      required: true
+  - type: input
+    id: vscode_version
+    attributes:
+      label: Visual Studio Code Version
+      description: |
+        What version of Visual Studio Code are you using?
+        How to find Visual Studio Code Version: https://code.visualstudio.com/docs/supporting/FAQ#_how-do-i-find-the-version
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context about the problem here.
+        The Foam log output for VSCode can be found here: https://github.com/foambubble/foam/blob/main/docs/user/tools/foam-logging-in-vscode.md

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,5 @@
 blank_issues_enabled: true
+contact_links:
+  - name: Question
+    url: https://foambubble.github.io/join-discord/g
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: Feature request
+description: Suggest an idea for the `Foam` project
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue form is for requesting features only!
+        If you want to report a bug, please use the [bug report](https://github.com/foambubble/foam/issues/new?assignees=&labels=&template=bug_report.yml) form.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but ___ ...
+        
+        Ideal Steps I would like to see:
+        1. Go to '...'
+        2. Click on '....'
+        3. ....
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓

.github/workflows/ci.yml

@@ -0,0 +1,76 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling with custom config file
+        uses: crate-ci/typos@v1.14.8
+        with:
+          config: ./typos.toml
+  lint:
+    name: Lint
+    runs-on: ubuntu-22.04
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - name: Restore Dependencies and VS Code test instance
+        uses: actions/cache@v3
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+            packages/foam-vscode/.vscode-test
+          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}-${{ secrets.CACHE_VERSION }}
+      - name: Install Dependencies
+        run: yarn
+      - name: Check Lint Rules
+        run: yarn lint
+
+  test:
+    name: Build and Test
+    # strategy:
+    #   matrix:
+    #     os: [macos-12, ubuntu-22.04, windows-2022]
+    # runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-22.04
+    # env:
+    #   OS: ${{ matrix.os }}
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - name: Restore Dependencies and VS Code test instance
+        uses: actions/cache@v3
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+            packages/foam-vscode/.vscode-test
+          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}-${{ secrets.CACHE_VERSION }}
+      - name: Install Dependencies
+        run: yarn
+      - name: Build Packages
+        run: yarn build
+      - name: Run Tests
+        uses: GabrielBB/xvfb-action@v1.4
+        with:
+          run: yarn test

.github/workflows/foam-cli.yml

@@ -1,26 +0,0 @@
-name: Test foam-cli
-
-on:
-  pull_request:
-    paths:
-      - 'packages/foam-cli/**'
-  push:
-    paths:
-      - 'packages/foam-cli/**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - name: Install dependencies
-        run: yarn
-
-      # - name: Lint foam-lint
-      #   run: yarn workspace foam-cli lint
-
-      - name: Test foam-cli
-        run: yarn workspace foam-cli test

.github/workflows/foam-core.yml

@@ -1,27 +0,0 @@
-name: Test foam-core
-
-on:
-  pull_request:
-    paths:
-      - 'packages/foam-core/**'
-  push:
-    paths:
-      - 'packages/foam-core/**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-
-      - name: Install dependencies
-        run: yarn
-
-      - name: Lint foam-core
-        run: yarn workspace foam-core lint
-
-      - name: Test foam-core
-        run: yarn workspace foam-core test

.github/workflows/foam-vscode.yml

@@ -1,31 +0,0 @@
-name: Test foam-vscode
-
-on:
-  pull_request:
-    paths:
-      - 'packages/foam-vscode/**'
-  push:
-    paths:
-      - 'packages/foam-vscode/**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-
-      - name: Install dependencies
-        run: yarn
-
-      - name: Lint foam-vscode
-        run: yarn workspace foam-vscode lint
-      - name: Test foam-vscode
-        run: yarn workspace foam-vscode test
-      # - name: Publish foam-vscode
-      #   if: github.ref == 'refs/heads/master'
-      #   run: yarn workspace foam-vscode publish-extension
-      #   with:
-      #     vsce_token: ${{ secrets.VSCE_TOKEN }}

.github/workflows/update-docs.yml

@@ -0,0 +1,49 @@
+name: Update Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/user/**/*
+      - docs/.vscode/**/*
+      - docs/assets/**/*
+  workflow_dispatch:
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: foambubble/foam-template
+          path: foam-template
+      - uses: actions/checkout@v3
+        with:
+          path: foam
+      - name: Copy and fixup user docs files
+        id: copy
+        run: |
+          rm -r foam-template/docs
+          rm -r foam-template/assets
+          rm -r foam-template/.vscode
+          cp -r foam/docs/user foam-template/docs
+          cp -r foam/docs/assets foam-template/assets
+          cp -r foam/docs/.vscode foam-template/.vscode
+
+          # Strip autogenerated wikileaks references because
+          # they are not an appropriate default user experience.
+          (cd foam-template/docs; find . -type f -name '*.md' -exec sed -i '/\[\/\/begin\]/,/\[\/\/end\]/d' {} +)
+
+          # Set the commit message format
+          echo "message=Docs sync @ $(cd foam; git log --pretty='format:%h %s')" >> $GITHUB_OUTPUT
+      - uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.FOAM_DOCS_SYNC_TOKEN }}
+          path: foam-template
+          commit-message: ${{ steps.copy.outputs.message }}
+          branch: bot/foam-docs-sync
+          delete-branch: true
+          title: Sync docs from foam
+          body: Copy docs from main foam repo

.gitignore

@@ -1,7 +1,14 @@
 node_modules
 .DS_Store
 .vscode-test/
+.vscode-test-web/
 *.tsbuildinfo
 *.vsix
 *.log
+out
 dist
+docs/_site
+docs/.sass-cache
+docs/.jekyll-metadata
+.test-workspace
+.agent/tasks

.vscode/launch.json

@@ -3,74 +3,51 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"type": "node",
-			"name": "vscode-jest-tests",
-			"request": "launch",
-			"runtimeArgs": ["workspace", "foam-core", "run", "test"], // ${yarnWorkspaceName} is what we're missing
-			"args": [
-					"--runInBand"
-			],
-			"runtimeExecutable": "yarn",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen",
-			"disableOptimisticBPs": true,
-	},
-		{
-			"name": "Debug Jest Tests",
-			"type": "node",
-			"request": "launch",
-			"runtimeArgs": [
-				"--inspect-brk",
-				"${workspaceRoot}/node_modules/.bin/tsdx",
-				"test",
-			],
-			"console": "integratedTerminal",
-			"cwd": "${workspaceFolder}/packages/foam-core",
-			"internalConsoleOptions": "neverOpen"
-	},
-		{
-			"name": "Run VSCode Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode"
-			],
-			"outFiles": [
-				"${workspaceFolder}/packages/foam-vscode/out/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-
-		// @NOTE: This task is broken. VSCode e2e tests are currently disabled
-		// due to incompability of jest and mocha inside a typescript monorepo
-		// Contributions to fix this are welcome!
-		{
-			"name": "Test VSCode Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode",
-				"--extensionTestsPath=${workspaceFolder}/packages/foam-vscode/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/packages/foam-vscode/out/test/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Test Core",
-			"type": "node",
-			"request": "launch",
-			"program": "${workspaceFolder}/node_modules/tsdx/dist/index.js",
-			"args": ["test"],
-			"cwd": "${workspaceFolder}/packages/foam-core",
-			"internalConsoleOptions": "openOnSessionStart",
-			"preLaunchTask": "${defaultBuildTask}"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Jest Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "${workspaceFolder}/packages/foam-vscode/.test-workspace",
+        "--disable-extensions",
+        "--disable-workspace-trust",
+        "--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode",
+        "--extensionTestsPath=${workspaceFolder}/packages/foam-vscode/out/test/suite"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/packages/foam-vscode/out/**/*.js"
+      ],
+      "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "name": "Run VSCode Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/packages/foam-vscode/out/**/*.js"
+      ],
+      "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "type": "node",
+      "name": "vscode-jest-tests",
+      "request": "launch",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "cwd": "${workspaceFolder}/packages/foam-vscode",
+      "runtimeExecutable": "yarn",
+      "args": [
+        "jest",
+        "--runInBand",
+        "--watchAll=false"
+      ]
+    }
+  ]
 }

.vscode/settings.json

@@ -1,21 +1,34 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-    "files.exclude": {
-        // set these to true to hide folders with the compiled JS files,
-        "packages/**/out": false,
-        "packages/**/dist": false
-    },
-    "search.exclude": {
-        // set this to false to include compiled JS folders in search results
-        "packages/**/out": true,
-        "packages/**/dist": true
-    },
-    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off",
-    "foam.files.ignore": [
-        "**/.vscode/**/*",
-        "**/_layouts/**/*",
-        "**/_site/**/*",
-        "**/node_modules/**/*"
-    ]
-}
+  "files.exclude": {
+    // set these to true to hide folders with the compiled JS files,
+    "packages/**/out": false,
+    "packages/**/dist": false
+  },
+  "search.exclude": {
+    // set this to false to include compiled JS folders in search results
+    "packages/**/out": true,
+    "packages/**/dist": true
+  },
+  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+  "typescript.tsc.autoDetect": "off",
+  "foam.edit.linkReferenceDefinitions": "withExtensions",
+  "foam.files.ignore": [
+    "**/.vscode/**/*",
+    "**/_layouts/**/*",
+    "**/_site/**/*",
+    "**/node_modules/**/*",
+    "packages/**/*"
+  ],
+  "editor.tabSize": 2,
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveMode": "file",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "jest.rootPath": "packages/foam-vscode",
+  "jest.jestCommandLine": "yarn test:unit",
+  "gitdoc.enabled": false,
+  "search.mode": "reuseEditor",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

.vscode/tasks.json

@@ -1,31 +1,52 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"label": "watch: foam-vscode",
-			"type": "npm",
-			"script": "start:vscode",
-			"problemMatcher": "$tsc-watch",
-			"isBackground": true,
-			"presentation": {
-				"reveal": "always"
-			},
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		},
-		{
-			"label": "test: all packages",
-			"type": "npm",
-			"script": "test",
-			"problemMatcher": [],
-			"group": {
-				"kind": "test",
-				"isDefault": true
-			},
-		}
-	]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "watch: foam-vscode",
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": {
+        "owner": "typescript",
+        "fileLocation": ["relative", "${workspaceFolder}"],
+        "pattern": [
+          {
+            "regexp": "^(.*?)\\((\\d+),(\\d+)\\):\\s+(.*)$",
+            "file": 1,
+            "line": 2,
+            "column": 3,
+            "message": 4
+          }
+        ],
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": {
+            "regexp": ".*"
+          },
+          "endsPattern": {
+            "regexp": ".*"
+          }
+        }
+      },
+      "isBackground": true,
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "label": "test: all packages",
+      "type": "npm",
+      "script": "test",
+      "problemMatcher": [],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      }
+    }
+  ]
 }

.yarnrc

@@ -0,0 +1 @@
+--ignore-engines true

CLAUDE.md

@@ -0,0 +1,263 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Collaboration Principles
+
+**Be honest and objective**: Evaluate all suggestions, ideas, and feedback on their technical merits. Don't be overly complimentary or sycophantic. If something doesn't make sense, doesn't align with best practices, or could be improved, say so directly and constructively. Technical accuracy and project quality take precedence over being agreeable.
+
+## Project overview
+
+Foam is a personal knowledge management and sharing system, built on Visual Studio Code and GitHub. It allows users to organize research, keep re-discoverable notes, write long-form content, and optionally publish it to the web. The main goals are to help users create relationships between thoughts and information, supporting practices like building a "Second Brain" or a "Zettelkasten". Foam is free, open-source, and extensible, giving users ownership and control over their information. The target audience includes individuals interested in personal knowledge management, note-taking, and content creation, particularly those familiar with VS Code and GitHub.
+
+## Quick Commands
+
+All the following commands are to be executed from the `packages/foam-vscode` directory
+
+### Development
+
+- `yarn install` - Install dependencies
+- `yarn build` - Build all packages
+- `yarn watch` - Watch mode for development
+- `yarn clean` - Clean build outputs
+- `yarn reset` - Full clean, install, and build
+
+### Testing
+
+- `yarn test` - Run all tests (unit + integration)
+- `yarn test:unit` - Run unit tests (\*.test.ts files and the .spec.ts files marked a vscode-mock friendly)
+- `yarn test:e2e` - Run only integration tests (\*.spec.ts files)
+- `yarn lint` - Run linting
+- `yarn test-reset-workspace` to clean test workspace
+
+Unit tests run in Node.js environment using Jest
+Integration tests require VS Code extension host
+When running tests, do not provide additional parameters, they are ignored by the custom runner script. You cannot run just a test, you have to run the whole suite.
+
+Unit tests are named `*.test.ts` and integration tests are `*.spec.ts`. These test files live alongside the code in the `src` directory. An integration test is one that has a direct or indirect dependency on `vscode` module.
+There is a mock `vscode` module that can be used to run most integration tests without starting VS Code. Tests that can use this mock are start with the line `/* @unit-ready */`.
+
+- If you are interested in a test inside a `*.test.ts` file, run `yarn test:unit` or inside a `*.spec.ts` file that starts with `/* @unit-ready */` run `yarn test:unit`
+- If you are interested in a test inside a `*.spec.ts` file that does not include `/* @unit-ready */` run `yarn test`
+
+While in development we mostly want to use `yarn test:unit`.
+When multiple tests are failing, look at all of them, but only focus on fixing the first one. Once that is fixed, run the test suite again and repeat the process.
+
+When writing tests keep mocking to a bare minimum. Code should be written in a way that is easily testable and if I/O is necessary, it should be done in appropriate temporary directories.
+Never mock anything that is inside `packages/foam-vscode/src/core/`.
+
+Use the utility functions from `test-utils.ts` and `test-utils-vscode.ts` and `test-datastore.ts`.
+
+To improve readability of the tests, set up the test and tear it down within the test case (as opposed to use other functions like `beforeEach` unless it's much better to do it that way)
+
+Never fix a test by adjusting the expectation if the expectation is correct, test must be fixed by addressing the issue with the code.
+
+## Repository Structure
+
+This is a monorepo using Yarn workspaces with the main VS Code extension in `packages/foam-vscode/`.
+
+### Key Directories
+
+- `packages/foam-vscode/src/core/` - Platform-agnostic business logic (NO vscode dependencies)
+- `packages/foam-vscode/src/features/` - VS Code-specific features and UI
+- `packages/foam-vscode/src/services/` - service implementations, might have VS Code dependency, but we try keep that to a minimum
+- `packages/foam-vscode/src/test/` - Test utilities and mocks
+- `docs/` - Documentation and user guides
+
+### File Naming Patterns
+
+Test files follow `*.test.ts` for unit tests and `*.spec.ts` for integration tests, living alongside the code in `src`. An integration test is one that has a direct or indirect dependency on `vscode` package.
+
+### Important Constraint
+
+Code in `packages/foam-vscode/src/core/` MUST NOT depend on the `vscode` library or any files outside the core directory. This maintains platform independence.
+
+## Architecture Overview
+
+### Core Abstractions
+
+**FoamWorkspace** - Central repository managing all resources (notes, attachments)
+
+- Uses reversed trie for efficient resource lookup
+- Event-driven updates (onDidAdd, onDidUpdate, onDidDelete)
+- Handles identifier resolution for short-form linking
+
+**FoamGraph** - Manages relationship graph between resources
+
+- Tracks links and backlinks between resources
+- Real-time updates when workspace changes
+- Handles placeholder resources for broken links
+
+**ResourceProvider Pattern** - Pluggable architecture for different file types
+
+- `MarkdownProvider` for .md files
+- `AttachmentProvider` for other file types
+- Extensible for future resource types
+
+**DataStore Interface** - Abstract file system operations
+
+- Platform-agnostic file access with configurable filtering
+- Supports both local and remote file systems
+
+### Feature Integration Pattern
+
+Features are registered as functions receiving:
+
+```typescript
+(context: ExtensionContext, foamPromise: Promise<Foam>) => void
+```
+
+This allows features to:
+
+- Register VS Code commands, providers, and event handlers
+- Access the Foam workspace when ready
+- Extend markdown-it for preview rendering
+
+### Testing Conventions
+
+- `*.test.ts` - Unit tests using Jest
+- `*.spec.ts` - Integration tests requiring VS Code extension host
+- Tests live alongside source code in `src/`
+- Test cases should be phrased in terms of aspects of the feature being tested (expected behaviors), as they serve both as validation of the code as well as documentation of what the expected behavior for the code is in different situations. They should include the happy paths and edge cases.
+
+## Development Workflow
+
+We build production code together. I handle implementation details while you guide architecture and catch complexity early.
+When working on an issue, check if a `.agent/tasks/<issue-id>-<sanitized-title>.md` exists. If not, suggest whether we should start by doing a research on it (using the `/research-issue <issue-id>`) command.
+Whenever we work together on a task, feel free to challenge my assumptions and ideas and be critical if useful.
+
+## Core Workflow: Research → Plan → Implement → Validate
+
+**Start every feature with:** "Let me research the codebase and create a plan before implementing."
+
+1. **Research** - Understand existing patterns and architecture
+2. **Plan** - Propose approach and verify with you
+3. **Implement** - Build with tests and error handling
+4. **Validate** - ALWAYS run formatters, linters, and tests after implementation
+
+- Whenever working on a feature or issue, let's always come up with a plan first, then save it to a file called `/.agent/current-plan.md`, before getting started with code changes. Update this file as the work progresses.
+- Let's use pure functions where possible to improve readability and testing.
+
+### Adding New Features
+
+1. Create feature in `src/features/` directory
+2. Register feature in `src/features/index.ts`
+3. Add tests (both unit and integration as needed)
+4. Update configuration in `package.json` if needed
+
+### Working on an issue
+
+1. Get the issue information from github
+2. Define a step by step plan for addressing the issue
+3. Create tests for the feature
+4. Starting from the first test case, implement the feature so the test passes
+
+### Core Logic Changes
+
+1. Modify code in `src/core/` (ensure no vscode dependencies)
+2. Add comprehensive unit tests
+3. Update integration tests in features that use the core logic
+
+## Configuration
+
+The extension uses VS Code's configuration system with the `foam.*` namespace.
+You can find all the settings in `/packages/foam-vscode/package.json`
+
+## Common Development Tasks
+
+### Extending Core Functionality
+
+When adding to `src/core/`:
+
+- Keep platform-agnostic (no vscode imports)
+- Add comprehensive unit tests
+- Consider impact on graph and workspace state
+- Update relevant providers if needed
+
+## Dependencies
+
+- **Runtime**: VS Code API, markdown parsing, file watching
+- **Development**: TypeScript, Jest, ESLint, esbuild
+- **Key Libraries**: remark (markdown parsing), lru-cache, lodash
+
+The extension supports both Node.js and browser environments via separate build targets.
+
+## Documentation Guidelines
+
+### User Documentation (`docs/user/`)
+
+Documentation in `docs/user/` must be written for non-technical users. The goal is to help novice users quickly start using features, not to explain technical implementation details.
+
+**Writing Guidelines:**
+
+- **Target audience**: Assume users are new to Foam and may not be technical
+- **Be concise**: Keep it short and to the point - every sentence must convey useful information
+- **Avoid repetition**: Don't repeat the same concept in different words
+- **Focus on "how to use"**: Show users what they can do and how to do it, not how it works internally
+- **Balance brevity with clarity**: Users won't read verbose documentation, but they need enough information to succeed
+- **Use examples**: Show practical use cases rather than abstract descriptions
+- **Start with the most common use case**: Lead with what most users will want to do first
+
+# GitHub CLI Integration
+
+To interact with the github repo we will be using the `gh` command.
+ALWAYS ask before performing a write operation on Github.
+
+## Common Commands for Claude Code Integration
+
+### Issues
+
+```bash
+# List all issues
+gh issue list
+
+# Filter issues by milestone
+gh issue list --milestone "v1.0.0"
+
+# Filter issues by assignee
+gh issue list --assignee @me
+gh issue list --assignee username
+
+# Filter issues by label
+gh issue list --label "bug"
+gh issue list --label "enhancement,priority-high"
+
+# Filter issues by state
+gh issue list --state open
+gh issue list --state closed
+gh issue list --state all
+
+# Combine filters
+gh issue list --milestone "v1.0.0" --label "bug" --assignee @me
+
+# View specific issue
+gh issue view 123
+
+# Create issue
+gh issue create --title "Bug fix" --body "Description"
+
+# Add comment to issue
+gh issue comment 123 --body "Update comment"
+```
+
+### Pull Requests
+
+```bash
+# List all PRs
+gh pr list
+
+# Filter PRs the same way as for filters (for example, here is by milestone)
+gh pr list --milestone "v1.0.0"
+
+# View PR details
+gh pr view 456
+
+# Create PR
+gh pr create --title "Feature" --body "Description"
+
+# Check out PR locally
+gh pr checkout 456
+
+# Add review comment
+gh pr comment 456 --body "LGTM"
+```

LICENSE

@@ -1,6 +1,6 @@
 The MIT Licence (MIT)
 
-Copyright 2020 Jani Eväkallio <jani.evakallio@gmail.com>
+Copyright 2020 - present Jani Eväkallio <jani.evakallio@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -17,4 +17,17 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Where noted, some code uses the following license:
+
+MIT License
+
+Copyright (c) 2015 - present Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:

docs/.vscode/custom-tag-style.css

@@ -0,0 +1,4 @@
+.foam-tag{
+  color:#ffffff;
+  background-color: #000000;
+}

docs/.vscode/extensions.json

@@ -5,20 +5,11 @@
     // Foam's own extension
     "foam.foam-vscode",
 
-    // Prettier for auto formatting code
-    "esbenp.prettier-vscode",
-
-    // GitLens for seeing version history inline
-    "eamodio.gitlens",
-
     // Tons of markdown goodies (lists, tables of content, so much more)
     "yzhang.markdown-all-in-one",
 
-    // [[wiki-links]], backlinking etc
-    "kortina.vscode-markdown-notes",
-
-    // Graph visualizer
-    "tchayen.markdown-links",
+    // Prettier for auto formatting code
+    "esbenp.prettier-vscode",
 
     // Understated grayscale theme (light and dark variants)
     "philipbe.theme-gray-matter"

docs/.vscode/foam.json

@@ -1,4 +0,0 @@
-{
-  "purpose": "this file exists to tell the foam-vscode plugin that it's currently in a foam workspace",
-  "future": "we may use this for custom configuration"
-}

docs/.vscode/keybindings.json

@@ -3,6 +3,6 @@
 [
   {
     "key": "cmd+shift+n",
-    "command": "vscodeMarkdownNotes.newNote"
+    "command": "foam-vscode.create-note"
   }
 ]

docs/.vscode/settings.json

@@ -4,9 +4,7 @@
   "editor.wrappingIndent": "indent",
   "editor.overviewRulerBorder": false,
   "editor.lineHeight": 24,
-  "workbench.colorTheme": "Gray Matter Light",
   "foam.edit.linkReferenceDefinitions": "withExtensions",
-  "vscodeMarkdownNotes.noteCompletionConvention": "noExtension",
   "[markdown]": {
     "editor.quickSuggestions": {
       "other": true,
@@ -14,7 +12,11 @@
       "strings": false
     }
   },
-  "cSpell.language": "en-GB",
   "git.enableSmartCommit": true,
-  "git.postCommitCommand": "sync"
+  "git.postCommitCommand": "sync",
+  "files.exclude": {
+    "_site/**": true
+  },
+  "files.insertFinalNewline": true,
+  "markdown.styles": [".vscode/custom-tag-style.css"]
 }

docs/404.md

@@ -0,0 +1,12 @@
+# Page not found!
+
+Well, that shouldn't have happened!
+
+If you got here via a link from another document, please file an [issue](https://github.com/foambubble/foam/issues) on our GitHub repo including:
+
+- the page you came from
+- the link you followed
+
+Thanks!
+
+-The Foam Team

docs/Gemfile

@@ -0,0 +1,37 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 3.9.0"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", "~> 209", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
+
+# kramdown v2 ships without the gfm parser by default. If you're using
+# kramdown v1, comment out this line.
+gem "kramdown-parser-gfm"

docs/Gemfile.lock

@@ -0,0 +1,272 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.11.1)
+    colorator (1.1.0)
+    commonmarker (0.17.13)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.1.7)
+    dnsruby (1.61.5)
+      simpleidn (~> 0.1)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    eventmachine (1.2.7)
+    execjs (2.7.0)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    ffi (1.13.1)
+    forwardable-extended (2.6.0)
+    gemoji (3.0.1)
+    github-pages (209)
+      github-pages-health-check (= 1.16.1)
+      jekyll (= 3.9.0)
+      jekyll-avatar (= 0.7.0)
+      jekyll-coffeescript (= 1.1.1)
+      jekyll-commonmark-ghpages (= 0.1.6)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.15.1)
+      jekyll-gist (= 1.5.0)
+      jekyll-github-metadata (= 2.13.0)
+      jekyll-mentions (= 1.6.0)
+      jekyll-optional-front-matter (= 0.3.2)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.3.0)
+      jekyll-redirect-from (= 0.16.0)
+      jekyll-relative-links (= 0.6.1)
+      jekyll-remote-theme (= 0.4.2)
+      jekyll-sass-converter (= 1.5.2)
+      jekyll-seo-tag (= 2.6.1)
+      jekyll-sitemap (= 1.4.0)
+      jekyll-swiss (= 1.0.0)
+      jekyll-theme-architect (= 0.1.1)
+      jekyll-theme-cayman (= 0.1.1)
+      jekyll-theme-dinky (= 0.1.1)
+      jekyll-theme-hacker (= 0.1.2)
+      jekyll-theme-leap-day (= 0.1.1)
+      jekyll-theme-merlot (= 0.1.1)
+      jekyll-theme-midnight (= 0.1.1)
+      jekyll-theme-minimal (= 0.1.1)
+      jekyll-theme-modernist (= 0.1.1)
+      jekyll-theme-primer (= 0.5.4)
+      jekyll-theme-slate (= 0.1.1)
+      jekyll-theme-tactile (= 0.1.1)
+      jekyll-theme-time-machine (= 0.1.1)
+      jekyll-titles-from-headings (= 0.5.3)
+      jemoji (= 0.12.0)
+      kramdown (= 2.3.0)
+      kramdown-parser-gfm (= 1.1.0)
+      liquid (= 4.0.3)
+      mercenary (~> 0.3)
+      minima (= 2.5.1)
+      nokogiri (>= 1.10.4, < 2.0)
+      rouge (= 3.23.0)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.16.1)
+      addressable (~> 2.3)
+      dnsruby (~> 1.60)
+      octokit (~> 4.0)
+      public_suffix (~> 3.0)
+      typhoeus (~> 1.3)
+    html-pipeline (2.14.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.9.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (>= 1.17, < 3)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-avatar (0.7.0)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-coffeescript (1.1.1)
+      coffee-script (~> 2.2)
+      coffee-script-source (~> 1.11.1)
+    jekyll-commonmark (1.3.1)
+      commonmarker (~> 0.14)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-commonmark-ghpages (0.1.6)
+      commonmarker (~> 0.17.6)
+      jekyll-commonmark (~> 1.2)
+      rouge (>= 2.0, < 4.0)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (0.15.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-gist (1.5.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.13.0)
+      jekyll (>= 3.4, < 5.0)
+      octokit (~> 4.0, != 4.4.0)
+    jekyll-mentions (1.6.0)
+      html-pipeline (~> 2.3)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-optional-front-matter (0.3.2)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-paginate (1.1.0)
+    jekyll-readme-index (0.3.0)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-relative-links (0.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-remote-theme (0.4.2)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-swiss (1.0.0)
+    jekyll-theme-architect (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-cayman (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-dinky (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-hacker (0.1.2)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-leap-day (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-merlot (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-midnight (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-minimal (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-modernist (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-primer (0.5.4)
+      jekyll (> 3.5, < 5.0)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-slate (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-tactile (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-time-machine (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-titles-from-headings (0.5.3)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    jemoji (0.12.0)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0, < 5.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.3.3)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    mini_portile2 (2.5.1)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    nokogiri (1.11.5)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    octokit (4.19.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.1.1)
+    racc (1.5.2)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.23.0)
+    ruby-enum (0.8.0)
+      i18n
+    ruby2_keywords (0.0.2)
+    rubyzip (2.3.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    simpleidn (0.1.1)
+      unf (~> 0.1.4)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2020.4)
+      tzinfo (>= 1.0.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+    wdm (0.1.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages (~> 209)
+  jekyll-feed (~> 0.6)
+  kramdown-parser-gfm
+  minima (~> 2.0)
+  tzinfo (~> 1.2)
+  tzinfo-data
+  wdm (~> 0.1.0)
+
+BUNDLED WITH
+   2.1.2

docs/LICENSE.txt

@@ -0,0 +1,33 @@
+The MIT Licence (MIT)
+
+Copyright 2020 - present Jani Eväkallio <jani.evakallio@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Where noted, some code uses the following license:
+
+MIT License
+
+Copyright (c) 2015 - present Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:

docs/_layouts/foam.html

@@ -19,21 +19,21 @@ window.addEventListener('DOMContentLoaded', (event) => {
   document
     .querySelectorAll(".markdown-body a[title]:not([href^=http])")
     .forEach((a) => {
-      // filter to only wiki-links
+      // filter to only wikilinks
       var prev = a.previousSibling;
       var next = a.nextSibling;
       if (
-        prev instanceof Text && prev.textContent.endsWith('[') && 
+        prev instanceof Text && prev.textContent.endsWith('[') &&
         next instanceof Text && next.textContent.startsWith(']')
       ) {
-        
+
         // remove surrounding brackets
         prev.textContent = prev.textContent.slice(0, -1);
         next.textContent = next.textContent.slice(1);
 
         // add CSS list for styling
         a.classList.add('wikilink');
-        
+
         // replace page-link with "Page Title"...
         a.innerText = a.title;
 

docs/automatic-git-syncing.md

@@ -1,11 +0,0 @@
-# Automatic Git Syncing (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.**
-
-If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
-
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[roadmap]: roadmap.md "Roadmap"
-[//end]: # "Autogenerated link references"

docs/backlinking.md

@@ -1,15 +0,0 @@
-# Backlinking
-
-When using [[wiki-links]], you can find all notes that link to a specific note in the [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) **Backlinks Explorer**
-
-- Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "backlinks" and run the **Explorer: Focus on Backlinks** view.
-- Keep this pane always visible to discover relationships between your thoughts
-- You can drag the backlinks pane to a different section in VS Code if you prefer. See: [[make-backlinks-more-prominent]]
-- Finding backlinks in published Foam workspaces via [[materialized-backlinks]] is on the [[roadmap]] but not yet implemented.
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links.md "Wiki Links"
-[make-backlinks-more-prominent]: make-backlinks-more-prominent.md "Make Backlinks More Prominent"
-[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
-[roadmap]: roadmap.md "Roadmap"
-[//end]: # "Autogenerated link references"

docs/big-vision.md

@@ -1,18 +0,0 @@
-# Big Vision
-
-[[todo]]
-
-- What methodologies do we want to support?
-  - Zettelkasten?
-  - GTD? (Get Things Done)
-  - Digital gardening?
-  - Blogging/publishing
-  - Others?
-- Be an educational tool as much as a tool to implement these methodologies
-- What use cases are we working towards?
-  -[[todo]] User round table
-
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[//end]: # "Autogenerated link references"

docs/block-references.md

@@ -1,10 +0,0 @@
-# Block References (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.**
-
-If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[roadmap]: roadmap.md "Roadmap"
-[//end]: # "Autogenerated link references"

docs/blog.md

@@ -1,7 +0,0 @@
-# Foam Blog
-
-- [[2020-07-11-three-weeks-in]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[2020-07-11-three-weeks-in]: blog/2020-07-11-three-weeks-in.md "Three Weeks In"
-[//end]: # "Autogenerated link references"

docs/blog/2020-07-11-three-weeks-in.md

@@ -1,3 +0,0 @@
-# Three Weeks In
-
-Todo

docs/contributing.md

@@ -1,7 +0,0 @@
-# Contributing
-
-Head over to the [[contribution-guide]]. `CONTRIBUTING.md` file name is blocklisted on GitHub pages, and doesn't appear in the [rendered output](https://foambubble.github.io/foam).
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[contribution-guide]: contribution-guide.md "Contribution Guide"
-[//end]: # "Autogenerated link references"

docs/contribution-guide.md

@@ -1,53 +0,0 @@
-# Contribution Guide
-
-> [[todo]] [[good-first-task]] This contribution guide itself could be improved 😅
-
-Foam is open to contributions of any kind, including but not limited to code, documentation, ideas, and feedback. Here are some general tips on how to get started on contributing to Foam:
-
-- Use Foam for yourself, figure out what could be improved.
-- Check out [[roadmap]] to see what's already in the plans. I have thoughts about how to implement some of these, but open to ideas and code contributions!
-- Read about our [[principles]] to understand Foam's philosophy and direction
-- Read and act in accordance with our [[code-of-conduct]].
-- Feel free to open [GitHub issues](https://github.com/foambubble/foam/issues) to give me feedback and ideas for new features.
-- Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/)
-  - [/docs](https://github.com/foambubble/foam/docs): documentation and [[recipes]]
-  - [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode): the core VSCode plugin
-  - [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core): powers the core functionality in Foam across all platforms
-- Exceptions to the monorepo are:
-  - The starter template at [foambubble/foam-template](https://github.com/foambubble/)
-  - All other [[recommended-extensions]] live in their respective GitHub repos.
-
-## Contributing to the VS Code Extension
-
-If you're interested in contributing to the VS Code extension (aka `foam-vscode`), this guide will help you get things set up locally.
-
-1. Clone the repo locally:
-
-   `git clone https://github.com/foambubble/foam.git`
-
-2. Install the necessary dependencies by running this command from the root:
-
-   `yarn install`
-
-3. This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).`foam-vscode` relies on `foam-core`. This means we need to compile it before we do any extension development. From the root, run the command:
-
-   `yarn workspace foam-core build`
-
-4. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/master/.vscode/launch.json) to start a new extension host of VS Code. From the root, or the `foam-vscode` workspace, press f5.
-5. In the new extension host of VS Code that launched, open a Foam workspace (e.g. your personal one, or a test-specific one created from foam-template). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a `.vscode/foam.json` file.
-6. Test a command to make sure it's working as expected. Open the Command Palette (Ctrl/Cmd + Shift + P) and select "Foam: Update Markdown Reference List". If you see no errors, it's good to go!
-
-For more resources related to the VS Code Extension, check out the links below:
-
-- [[tutorial-adding-a-new-command-to-the-vs-code-extension]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[good-first-task]: good-first-task.md "Good First Task"
-[roadmap]: roadmap.md "Roadmap"
-[principles]: principles.md "Principles"
-[code-of-conduct]: code-of-conduct.md "Code of Conduct"
-[recipes]: recipes.md "Recipes"
-[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
-[tutorial-adding-a-new-command-to-the-vs-code-extension]: tutorial-adding-a-new-command-to-the-vs-code-extension.md "Tutorial: Adding a New Command to the VS Code Extension"
-[//end]: # "Autogenerated link references"

docs/creating-a-new-language.md

@@ -1,13 +0,0 @@
-# Creating a New Language
-
-## Creating a new language
-
-What if we created a new language that made it more ergonomic to use VS Code as a Foam workspace
-
-- Based on markdown
-- Could leverage mdx?
-- Shortcuts, like links between pages
-- Downside: Not markdown compatible, not so good for other tools
-  - Could it be a markdown superset?
-  - Or a language that transpiles to markdown and back, so it can be edited in "Foam" format and committed in MD so it's viewable on GH as markdown
-    - How imporant is it that links are navigable on GH? I guess it is

docs/creating-new-notes.md

@@ -1,12 +0,0 @@
-# Creating New Notes
-
-- Write out a new `[[wiki-link]]` and `Cmd` + `Click` to create a new file and enter it.
-  - For keyboard navigation, use the 'Follow Definition' key `F12` (or [remap key binding](https://code.visualstudio.com/docs/getstarted/keybindings) to something more ergonomic)
-- `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), execute `New Note` from [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) and enter a **Title Case Name** to create `title-case-name.md`
-  - Add a keyboard binding to make creating new notes easier.
-- You shouldn't worry too much about categorising your notes. You can always [[search-for-notes]], and explore them using the [[graph-visualisation]].
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[search-for-notes]: search-for-notes.md "Search for Notes"
-[graph-visualisation]: graph-visualisation.md "Graph visualisation"
-[//end]: # "Autogenerated link references"

docs/custom-markdown-preview-styles.md

@@ -1,15 +0,0 @@
-# Custom Markdown Preview Styles
-
-Visual Studio Code allows you to use your own CSS in the Markdown preview tab.
-
-## Instructions
-
-Custom CSS for the Markdown preview can be implemented by using the `"markdown.styles": []` setting in `settings.json`. The stylesheets can either be https URLs or relative paths to local files in the current workspace.
-
-For example, to load a stylesheet called `Style.css`, we can update `settings.json` with the following line:
-
-```
-{
-  "markdown.styles": ["Style.css"]
-}
-```

docs/customising-styles.md

@@ -1,10 +0,0 @@
-# Customising Styles
-
-You can edit `assets/css/style.scss` to change how published pages look.
-
-[[todo]] [[good-first-task]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[good-first-task]: good-first-task.md "Good First Task"
-[//end]: # "Autogenerated link references"

docs/daily-notes.md

@@ -1,54 +0,0 @@
-# Daily notes
-
-Automatically create a Daily Note by executing the "Foam: Open Daily Note" command. If a Daily Note for today's date already exists, the command opens the existing note.
-
-![Daily note feature in action](assets/images/daily-note.gif)
-
-## Keyboard shortcut
-
-The default keyboard shortcut for "Open Daily Note" is `alt`+`d`. This can be overridden using the [VS Code Keybindings editor](https://code.visualstudio.com/docs/getstarted/keybindings).
-
-## Configuration
-
-By default, Daily Notes will be created in a file called `yyyy-mm-dd.md` in the workspace root, with a heading `yyyy-mm-dd`.
-
-These settings can be overridden in your workspace or global `.vscode/settings.json` file, using the [**dateformat** date masking syntax](https://github.com/felixge/node-dateformat#mask-options):
-
-```json
-  "foam.openDailyNote.directory": "journal",
-  "foam.openDailyNote.filenameFormat": "'daily-note'-yyyy-mm-dd",
-  "foam.openDailyNote.fileExtension": "mdx",
-  "foam.openDailyNote.titleFormat": "'Journal Entry, ' dddd, mmmm d",
-```
-
-The above configuration would create a file `journal/note-2020-07-25.mdx`, with the heading `Journal Entry, Sunday, July 25`.
-
-## Daily Note Templates
-
-In the future, Foam may provide a functionality for specifying a template for new Daily Notes and other types of documents.
-
-In the meantime, you can use [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets) for defining your own Daily Note template.
-
-## Roam-style Automatic Daily Notes
-
-In the future, Foam may provide an option for automatically opening your Daily Note when you open your Foam workspace.
-
-If you want this behavior now, you can use the excellent [Auto Run Command](https://marketplace.visualstudio.com/items?itemName=gabrielgrinberg.auto-run-command#review-details) extension to run the "Open Daily Note" command upon entering a Foam workspace by specifying the following configuration in your `.vscode/settings.json`:
-
-```json
-  "auto-run-command.rules": [
-    {
-      "condition": "hasFile: .vscode/foam.json",
-      "command": "foam-vscode.open-daily-note",
-      "message": "Have a nice day!"
-    }
-  ],
-```
-
-## Extend Functionality (Weekly, Monthly, Quarterly Notes)
-
-Please see [[note-macros]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[note-macros]: note-macros.md "Custom Note Macros"
-[//end]: # "Autogenerated link references"

docs/decision-needed.md

@@ -1,3 +0,0 @@
-# Decision Needed
-
-Check backlinks

docs/decision.md

@@ -1,2 +0,0 @@
-# Decision
-

docs/dev/about-docs.md

@@ -0,0 +1,20 @@
+# 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`
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[link-reference-definitions]: ../user/features/link-reference-definitions.md "Link Reference Definitions"
+[todo]: todo.md "Todo"
+[//end]: # "Autogenerated link references"

docs/dev/build-vs-assemble.md

@@ -3,14 +3,10 @@
 The Foam prototype is built by assembling third-party extensions, which seems like a good strategy because
 
 - It supports picking and mixing of tools and workflows
-- Less code to write an maintain
+- Less code to write and maintain
 
 But there's also a bunch of roadmap items that are hard to implement this way, as the third party plugins don't do exactly what we want them to do (e.g. Markdown All In One is not compatible with [[referencing-notes-by-title]].
 
 Overall, we should strive to build big things from small things. Focused, interoperable modules are better, because they allow users to pick and mix which features work for them. A good example of why this matters is the Markdown All In One extension we rely on: While it provides many of the things we need, a few of its features are incompatible with how I would like to work, and therefore it becomes a limiter of how well I can improve my own workflow.
 
 However, there becomes a point where we may benefit from implementing a centralised solution, e.g. a syntax, an extension or perhaps a VSCode language server. As much as possible, we should allow users to operate in a decentralised manner.
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[referencing-notes-by-title]: referencing-notes-by-title.md "Referencing notes by title"
-[//end]: # "Autogenerated link references"

docs/dev/code-of-conduct.md

@@ -1,3 +1,8 @@
+---
+redirect_from:
+  - /code-of-conduct
+---
+
 # Code of Conduct
 
 We follow the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
@@ -61,7 +66,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at `jani.evakallio+foam@gmail.com`.
+reported to the community leaders responsible for enforcement at `riki.code+foam@gmail.com`.
 
 All complaints will be reviewed and investigated promptly and fairly.
 
@@ -118,7 +123,7 @@ the community.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
@@ -126,7 +131,5 @@ enforcement ladder](https://github.com/mozilla/diversity).
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
-
-
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

docs/dev/contribution-guide.md

@@ -0,0 +1,118 @@
+---
+tags: todo, good-first-task
+---
+
+# Contribution Guide
+
+Foam is open to contributions of any kind, including but not limited to code, documentation, ideas, and feedback.
+This guide aims to help guide new and seasoned contributors getting around the Foam codebase. For a comprehensive guide about contributing to open-source projects in general, [see here](https://blog.robsewell.com/blog/how-to-fork-a-github-repository-and-contribute-to-an-open-source-project/).
+
+## Getting Up To Speed
+
+Before you start contributing we recommend that you read the following links:
+
+- [[principles]] - This document describes the guiding principles behind Foam.
+- [[code-of-conduct]] - Rules we hope every contributor aims to follow, allowing everyone to participate in our community!
+
+To get yourself familiar with the codebase you can also browse [this repo](https://app.komment.ai/wiki/github/foambubble/foam)
+
+## Diving In
+
+We understand that diving in an unfamiliar codebase may seem scary,
+to make it easier for new contributors we provide some resources:
+
+You can also see [existing issues](https://github.com/foambubble/foam/issues) and help out!
+Finally, the easiest way to help, is to use it and provide feedback by [submitting issues](https://github.com/foambubble/foam/issues/new/choose) or participating in the [Foam Community Discord](https://foambubble.github.io/join-discord/g)!
+
+## Contributing
+
+If you're interested in contributing, this short guide will help you get things set up locally (assuming [node.js >= v18](https://nodejs.org/) and [yarn](https://yarnpkg.com/) are already installed on your system).
+You can also use the provided [[devcontainers]] to avoid installing dependencies locally. With the Dev Containers extension installed, open the repository in VS Code and run **Dev Containers: Reopen in Container**.
+
+1. Fork the project to your Github account by clicking the "Fork" button on the top right hand corner of the project's [home repository page](https://github.com/foambubble/foam).
+2. Clone your newly forked repo locally:
+
+   `git clone https://github.com/your_username/foam.git`
+
+3. Install the necessary dependencies by running this command from the root of the cloned repository:
+
+   `yarn install`
+
+4. From the repository root, run the command:
+
+   `yarn build`
+
+You should now be ready to start working!
+
+### Structure of the project
+
+Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/).
+
+- [/docs](https://github.com/foambubble/foam/tree/main/docs): documentation and [[recipes]].
+
+Exceptions to the monorepo are:
+
+- The starter template at [foambubble/foam-template](https://github.com/foambubble/)
+- All other [[recommended-extensions]] live in their respective GitHub repos
+
+This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
+
+Originally Foam had:
+
+- [/packages/foam-core](https://github.com/foambubble/foam/tree/ee7a8919761f168d3931079adf21c5ad4d63db59/packages/foam-core) - Powers the core functionality in Foam across all platforms.
+- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/main/packages/foam-vscode) - The core VS Code plugin.
+
+To improve DX we have moved the `foam-core` module into `packages/foam-vscode/src/core`, but from a development point of view it's useful to think of the `foam-vscode/src/core` "submodule" as something that might be extracted in the future.
+
+For all intents and purposes this means two things:
+
+1. nothing in `foam-vscode/src/core` should depend on files outside of this directory
+2. code in `foam-vscode/src/core` should NOT depend on `vscode` library
+
+We have kept the yarn workspace for the time being as we might use it to pull out `foam-core` in the future, or we might need it for other packages that the VS Code plugin could depend upon (e.g. currently the graph visualization is inside the module, but it might be pulled out if its complexity increases).
+
+### Testing
+
+Code needs to come with tests.
+We use the following convention in Foam:
+
+- `*.test.ts` are unit tests
+- `*.spec.ts` are integration tests
+
+Tests live alongside the code in `src`.
+
+### The VS Code Extension
+
+This guide assumes you read the previous instructions and you're set up to work on Foam.
+
+1. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/main/.vscode/launch.json) to start a new extension host of VS Code. Open the "Run and Debug" Activity (the icon with the bug on the far left) and select "Run VSCode Extension" in the pop-up menu. Now hit F5 or click the green arrow "play" button to fire up a new copy of VS Code with your extension installed.
+
+2. In the new extension host of VS Code that launched, open a Foam workspace (e.g. your personal one, or a test-specific one created from [foam-template](https://github.com/foambubble/foam-template)).
+
+3. Test a command to make sure it's working as expected. Open the Command Palette (Ctrl/Cmd + Shift + P) and select "Foam: Update Markdown Reference List". If you see no errors, it's good to go!
+
+### Submitting a Pull Request (PR)
+
+After you have made your changes to your copy of the project, it is time to try and merge those changes into the public community project.
+
+1. Return to the project's [home repository page](https://github.com/foambubble/foam).
+2. Github should show you an button called "Compare & pull request" linking your forked repository to the community repository.
+3. Click that button and confirm that your repository is going to be merged into the community repository. See [this guide](https://blog.robsewell.com/blog/how-to-fork-a-github-repository-and-contribute-to-an-open-source-project/) for more specifics.
+4. Add as many relevant details to the PR message to make it clear to the project maintainers and other members of the community what you have accomplished with your new changes. Link to any issues the changes are related to.
+5. Your PR will then need to be reviewed and accepted by the other members of the community. Any discussion about the changes will occur in your PR thread.
+6. Once reviewed and accept you can complete the merge request!
+7. Finally rest and watch the sun rise on a grateful universe... Or start tackling the other open issues ;)
+
+---
+
+Feel free to modify and submit a PR if this guide is out-of-date or contains errors!
+
+---
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[principles]: ../principles.md "Principles"
+[code-of-conduct]: code-of-conduct.md "Code of Conduct"
+[devcontainers]: devcontainers.md "Using Dev Containers"
+[recipes]: ../user/recipes/recipes.md "Recipes"
+[recommended-extensions]: ../user/getting-started/recommended-extensions.md "Recommended Extensions"
+[//end]: # "Autogenerated link references"

docs/dev/devcontainers.md

@@ -0,0 +1,13 @@
+# Using Dev Containers
+
+Foam provides a [devcontainer](https://devcontainer.ai/) configuration to make it easy to contribute without installing Node and Yarn locally.
+
+## Quick start
+
+1. Install [VS Code](https://code.visualstudio.com/) and the [Dev Containers](https://aka.ms/vscode-remote/download/extension) extension.
+2. Open the Foam repository in VS Code.
+3. Run **Dev Containers: Reopen in Container** from the command palette.
+
+This will build a Docker image with Node 18 and install dependencies using `yarn install`. Once ready you can run the usual build and test commands from the integrated terminal.
+
+

docs/dev/foam-file-format.md

@@ -0,0 +1,15 @@
+# Foam File Format
+
+This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for MediaWiki-style `[[wikilinks]]` and note embeds.
+
+Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wikilinks]]`:
+
+- **The first top level `# Heading` will be used as title for the note.**
+  - If not available, we will use the file name
+- **File name should have extension `.md`**
+  - This is a temporary limitation and will be lifted in future versions.
+  - At least `.mdx` will be supported, but ideally we'll support any file that you can map to `Markdown` language mode in VS Code
+- **In addition to normal Markdown Links syntax you can use `[[MediaWiki]]` links.** See [[wikilinks]] for more details.
+- **You can embed other notes using `![[note]]` syntax.** This supports various modifiers like `content![[note]]` or `full-card![[note]]` to control how content is displayed.
+
+[wikilinks]: ../user/features/wikilinks.md 'Wikilinks'

docs/dev/good-first-task.md

@@ -5,5 +5,5 @@ See the backlinks of this page for good first contribution opportunities.
 [[materialized-backlinks]] would help here.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
+[materialized-backlinks]: proposals/materialized-backlinks.md "Materialized Backlinks (stub)"
 [//end]: # "Autogenerated link references"

docs/dev/mdx-by-default.md

@@ -6,5 +6,5 @@ If you're interested in working on it, please start a conversation in [GitHub is
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: todo.md "Todo"
-[roadmap]: roadmap.md "Roadmap"
+[roadmap]: proposals/roadmap.md "Roadmap"
 [//end]: # "Autogenerated link references"

docs/dev/proposals/foam-core.md

@@ -9,7 +9,7 @@
   - Visualizations
     - Tag clouds
     - Graph
-    - Should we have a package for visualisation?
+    - Should we have a package for visualization?
       - [[build-vs-assemble]]
       - Not everything needs to live in the Foam repo
   - Web based UI (Monaco)
@@ -17,7 +17,7 @@
 `foam-core`'s primary responsibility is to build an API on top of a workspace of markdown files, which allows us to:
 
 - Treat files as a graph, based on links
-  - Can be either [[wiki-links]] or relative `[markdown](links.md)` style
+  - Can be either [[wikilinks]] or relative `[markdown](links.md)` style
   - We need to know about the edges (connections) as well as nodes
     - What link points to what other file, etc.
     - Needs to have the exact link text, e.g. even if `[[some-page]]` or `[[some-page.md]]` or `[[Some Page]]` point to the same document (`./some-page.md`), we need to know which format was used, so [[link-reference-definitions]] can be generated correctly
@@ -61,11 +61,11 @@ Here are some example use cases that the core should support. They don't need to
 
 - Adding and editing page content
   - [[materialized-backlinks]]
-  - [[link-reference-definitions]] for [[wiki-links]]
+  - [[link-reference-definitions]] for [[wikilinks]]
   - [Frontmatter](https://jekyllrb.com/docs/front-matter/)
 - Finding all documents with `#tag`
 - Finding all documents with instances of `[[link]]`
-- Visualisations
+- Visualizations
 - Full text search
 
   - Or, if search is too expensive/complex, when given a list of file names and line/column positions from VS Code search API, can return the document context (e.g. full paragraph, preceding/following line etc)
@@ -96,13 +96,12 @@ Useful for knowing what needs to be supported. See [[feature-comparison]].
 - [[foam-core-2020-07-11]]
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[workspace-janitor]: workspace-janitor.md "Janitor"
-[cli]: cli.md "Command Line Interface"
-[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
-[wiki-links]: wiki-links.md "Wiki Links"
-[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[workspace-janitor]: ../../user/tools/workspace-janitor.md "Janitor"
+[cli]: ../../user/tools/cli.md "Command Line Interface"
+[build-vs-assemble]: ../build-vs-assemble.md "Build vs Assemble"
+[wikilinks]: ../../user/features/wikilinks.md "Wikilinks"
+[link-reference-definitions]: ../../user/features/link-reference-definitions.md "Link Reference Definitions"
 [materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
-[todo]: todo.md "Todo"
-[feature-comparison]: feature-comparison.md "Feature comparison"
-[foam-core-2020-07-11]: meeting-notes/foam-core-2020-07-11.md "Foam Core 2020-07-11"
+[todo]: ../todo.md "Todo"
+[foam-core-2020-07-11]: ../meeting-notes/foam-core-2020-07-11.md "Foam Core 2020-07-11"
 [//end]: # "Autogenerated link references"

docs/dev/proposals/inclusion-of-notes.md

@@ -0,0 +1,48 @@
+# Inclusion of notes Proposal <!-- omit in TOC -->
+
+Currently it is not possible within Foam to include other notes into a note. Next to including a full note it could be interesting to add functionalities that allow for greater flexibility. This proposal discusses some functionalities around inclusion of notes.
+
+**IMPORTANT: This design is merely a proposal of a design that could be implemented. It DOES NOT represent a commitment by `Foam` developers to implement the features outlined in this document. This document is merely a mechanism to facilitate discussion of a possible future direction for `Foam`.**
+
+- [Introduction](#introduction)
+- [New features](#new-features)
+  - [Including a note](#including-a-note)
+  - [Include a section of a note](#include-a-section-of-a-note)
+  - [Include an attribute of a file (note property or frontmatter)](#include-an-attribute-of-a-file-note-property-or-frontmatter)
+
+## Introduction
+
+Initial work and thought on including a note was ignited by issue [#652](https://github.com/foambubble/foam/issues/652). Requested by a user was a likewise functionality as offered in Obsidian. This was simply the ability to include a note.
+
+Whilst researching digital gardening for my own setup, I came across an in-depth overview by [Maggie Appleton](https://maggieappleton.com/roam-garden). Showing examples of her personal Roam Research I see valuable possibilities to connect more information, if we would add additional functionalities to the possibility of including a note. This proposal displays these possible functionalities and markup.
+
+## New features
+
+### Including a note
+
+The minimal functionality is the ability to fully include a note. Markup used in Obsidian for this is `![[wikilink]]`. For Foam I would suggest to follow this syntax. Benefits being:
+
+- Adds minimal amount of knowledge required as syntax is based on the syntax of creating a wikilink.
+- Makes the auto-complete work ouf-of-the-box, without any additional code and listeners required.
+
+**Important**. A risk exists that a loop of including the same notes arises. E.g. Note A includes note B which includes note A. This needs to be prevented by the implementation and made visible to the user.
+
+### Include a section of a note
+
+It could be interesting to only include a section of a note instead of the entire note. In order to do so the user should be able to use the following syntax:
+
+`![[wikilink#section-b]]`
+
+As a result it will include the section title + section content until the next section *or* end of file.
+
+### Include an attribute of a file (note property or frontmatter)
+
+As a user I could be interested in collecting the value of any given property for a note. For example, I might want to include the tags as defined in the frontmatter of note A. This should be possible via the syntax:
+
+`![[wikilink:<property>]]`
+
+The property value should be looked up by foam defined properties, e.g. title, **or** any property defined in the frontmatter of a note.
+
+So, the example of including the tags of a note should be:
+
+`![[wikilink:tags]]`

docs/dev/proposals/link-reference-definition-improvements.md

@@ -4,13 +4,13 @@
 
 ### File-by-file Insertion
 
-For the time being, if you want to get [[wiki-links]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam).
+For the time being, if you want to get [[wikilinks]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam).
 
 ### Wikilinks don't work on GitHub
 
 > **TL;DR;** [workaround](#workaround) in the end of the chapter.
 
-If you click any of the wiki-links on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error.
+If you click any of the wikilinks on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error.
 
 At the time of writing (June 28 2020) this is a known, but unsolved error. To understand why this is the case, we need to understand what we are trading off.
 
@@ -59,19 +59,21 @@ Problem space in essence:
     - may clutter the search results
 - During build-time (when converting markdown to html for publishing purposes)
   - link reference definitions are needed, if the files are published via such tools (or to such platforms) that don't understand wikilinks
-  - link reference definitions might have to be in different formats depending on the publish target (e.g. Github pages vs Github UI)
+  - link reference definitions might have to be in different formats depending on the publish target (e.g. GitHub pages vs GitHub UI)
 
 The potential solution:
 
 - For edit-time
   - Make edit-time link reference definition generation optional via user settings. They should be on by default, and generating valid markdown links with a relative path to a `.md` file.
   - Make format of the link reference definition configurable (whether to include '.md' or not)
-  - Out of recommended extensions, currently only "markdown links" doesn't support them (?). However even its [code](https://github.com/tchayen/markdown-links/blob/master/src/parsing.ts#L25) seems to include wikilink parser, so it might just be a bug?
+  - Out of recommended extensions, currently only "markdown links" doesn't support them (?). However even its [code](https://github.com/tchayen/markdown-links/blob/main/src/parsing.ts#L25) seems to include wikilink parser, so it might just be a bug?
 - For build-time
+
   - To satisfy mutually incompatible constraints between GitHub UI, VSCode UI, and GitHub Pages, we should add a pre-processing/build step for pushing to GitHub Pages.
     - This would be a GitHub action (or a local script, ran via foam-cli) that outputs publish-friendly markdown format for static site generators and other publishing tools
     - This build step should be pluggable, so that other transformations could be ran during it
   - Have publish targets defined in settings, that support both turning the link reference definitions on/off and defining their format (.md or not). Example draft (including also edit-time aspect):
+
     ```typescript
     // settings json
     // see enumerations below for explanations on values
@@ -116,13 +118,15 @@ The potential solution:
     enum LinkReferenceDefinitions {
       Off,               // link reference definitions are not generated
       WithExtensions,    // link reference definitions contain .md (or similar) file extensions
-      WithoutExtensions  // link reference definitions do not contain file extenions
+      WithoutExtensions  // link reference definitions do not contain file extensions
     }
 
     ```
-  - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the Github UI
-  - Have publish target defined for Github pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation.
+
+  - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the GitHub UI
+  - Have publish target defined for GitHub pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation.
     - This naturally requires first removing the existing link reference definitions during the build
+
 - Other
   - To clean up the search results, remove link reference definition section guards (assuming that these are not defined by the markdown spec). Use unifiedjs parse trees to identify if there's missing (or surplus) definitions (check if they are identified properly by the library), and just add the needed definitions to the bottom of the file (without guards) AND remove them if they are not needed (anywhere from the file).
 
@@ -135,7 +139,7 @@ UI-wise, the publish targets could be picked in some similar fashion as the run/
 - [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16)
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links.md "Wiki Links"
-[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
-[backlinking]: backlinking.md "Backlinking"
+[wikilinks]: ../../user/features/wikilinks.md "Wikilinks"
+[link-reference-definitions]: ../../user/features/link-reference-definitions.md "Link Reference Definitions"
+[backlinking]: ../../user/features/backlinking.md "Backlinking"
 [//end]: # "Autogenerated link references"

docs/dev/proposals/materialized-backlinks.md

@@ -12,6 +12,6 @@ The idea would be to automatically generate lists of backlinks (and optionally,
 - Make Foam notes more portable to different apps and long-term storage
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
+[todo]: ../todo.md "Todo"
 [roadmap]: roadmap.md "Roadmap"
 [//end]: # "Autogenerated link references"

docs/dev/proposals/roadmap.md

@@ -6,21 +6,17 @@ Some of these items can be achieved by combining existing tools, but others may
 
 Items that are already being worked on. Roadmap items in this stage should have an owner.
 
-- [@jevakallio](https://github.com/jevakallio): [[cli]]
-
 ## High priority
 
 Items we plan on working next. Items in this stage don't need to have an owner, but before we start working on them should have enough specification that they can be picked up and worked on without having to seek consensus.
 
 If you want to pick up work in this category, you should have a plan on how long the implementation will approximately take so we don't block progress by sitting on high priority issues.
 
-- [[workspace-janitor]]
-
 ## Backlog
 
 Everything else, categorised into themes. Just because something is on this list doesn't mean it'll get done. If you're interested in working on items in this category, check the [[contribution-guide]] for how to get started.
 
-If a roadmap item is a stub, **consider** opening a [GitHub issue](https://github.com/foambubble/foam/issues) to start a conversation to avoid situations where the implementation does not fit long term vision and roadmap. _Note that this is optional. The only centralised governance in Foam is to decide what ends up in the official [template](https://github.com/foambubble/foam-template), [documentation](https://github.com/foambubble/foam) and [extension](https://github.com/foambubble/foam/tree/master/packages/foam-vscode). You are free to build whatever you want for yourself, and we'd love if you shared it with us, but you are by no means obligated to do so!_
+If a roadmap item is a stub, **consider** opening a [GitHub issue](https://github.com/foambubble/foam/issues) to start a conversation to avoid situations where the implementation does not fit long term vision and roadmap. _Note that this is optional. The only centralised governance in Foam is to decide what ends up in the official [template](https://github.com/foambubble/foam-template), [documentation](https://github.com/foambubble/foam) and [extension](https://github.com/foambubble/foam/tree/main/packages/foam-vscode). You are free to build whatever you want for yourself, and we'd love if you shared it with us, but you are by no means obligated to do so!_
 
 **When creating GitHub issues to discuss roadmap items, link them here.**
 
@@ -29,7 +25,7 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
 - [[improve-default-workspace-settings]]
   - Discussion: [foam#270](https://github.com/foambubble/foam/issues/270)
 - Improve [[git-integration]]
-- Fix [[wiki-links]] compatibility issues
+- Fix [[wikilinks]] compatibility issues
 - Simplify [[foam-file-format]]
 
 ### Core features
@@ -87,39 +83,21 @@ The community is working on a number of automated scripts to help you migrate to
 - [[refactoring-via-language-server-protocol]]
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
-[recipes]: recipes.md "Recipes"
-[cli]: cli.md "Command Line Interface"
-[workspace-janitor]: workspace-janitor.md "Janitor"
-[contribution-guide]: contribution-guide.md "Contribution Guide"
-[improve-default-workspace-settings]: improve-default-workspace-settings.md "Improve Default Workspace Settings (stub)"
-[git-integration]: git-integration.md "Git integration"
-[wiki-links]: wiki-links.md "Wiki Links"
-[foam-file-format]: foam-file-format.md "Foam File Format"
-[renaming-files]: renaming-files.md "Renaming files (stub)"
-[unlinked-references]: unlinked-references.md "Unlinked references (stub)"
-[block-references]: block-references.md "Block References (stub)"
-[improved-backlinking]: improved-backlinking.md "Improved Backlinking (stub)"
-[make-backlinks-more-prominent]: make-backlinks-more-prominent.md "Make Backlinks More Prominent"
+[build-vs-assemble]: ../build-vs-assemble.md "Build vs Assemble"
+[recipes]: ../../user/recipes/recipes.md "Recipes"
+[contribution-guide]: ../contribution-guide.md "Contribution Guide"
+[wikilinks]: ../../user/features/wikilinks.md "Wikilinks"
+[foam-file-format]: ../foam-file-format.md "Foam File Format"
+[unlinked-references]: ../unlinked-references.md "Unlinked references (stub)"
+[make-backlinks-more-prominent]: ../../user/recipes/make-backlinks-more-prominent.md "Make Backlinks More Prominent"
 [materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
-[automatic-git-syncing]: automatic-git-syncing.md "Automatic Git Syncing (stub)"
-[git-flows-for-teams]: git-flows-for-teams.md "Git Flows for Teams (stub)"
-[user-settings]: user-settings.md "User Settings (stub)"
-[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
-[predefined-user-snippets]: predefined-user-snippets.md "Pre-defined User Snippets"
-[officially-support-alternative-templates]: officially-support-alternative-templates.md "Officially Support Alternative Templates (stub)"
-[improved-static-site-generation]: improved-static-site-generation.md "Improved Static Site Generation (stub)"
-[mdx-by-default]: mdx-by-default.md "MDX by Default(stub)"
-[search-in-published-workspace]: search-in-published-workspace.md "Search in Published Workspace (stub)"
-[graph-in-published-workspace]: graph-in-published-workspace.md "Graph in Published Workspace (stub)"
-[linking-between-published-workspaces]: linking-between-published-workspaces.md "Linking between Published Workspaces (stub)"
-[publishing-permissions]: publishing-permissions.md "Publishing Permissions(stub)"
-[mobile-apps]: mobile-apps.md "Mobile Apps"
-[packaged-desktop-app]: packaged-desktop-app.md "Packaged Desktop App (stub)"
-[web-editor]: web-editor.md "Web Editor (stub)"
-[migrating-from-roam]: migrating-from-roam.md "Migrating from Roam (stub)"
-[migrating-from-obsidian]: migrating-from-obsidian.md "Migrating from Obsidian (stub)"
-[migrating-from-onenote]: migrating-from-onenote.md "Migrating from OneNote"
-[foam-linter]: foam-linter.md "Foam Linter (stub)"
-[refactoring-via-language-server-protocol]: refactoring-via-language-server-protocol.md "Refactoring via Language Server Protocol (stub)"
+[automatic-git-syncing]: ../../user/recipes/automatic-git-syncing.md "Automatically Sync with Git"
+[link-reference-definitions]: ../../user/features/link-reference-definitions.md "Link Reference Definitions"
+[predefined-user-snippets]: ../../user/recipes/predefined-user-snippets.md "Pre-defined User Snippets"
+[mdx-by-default]: ../mdx-by-default.md "MDX by Default(stub)"
+[publishing-permissions]: ../publishing-permissions.md "Publishing Permissions(stub)"
+[cli]: ../../user/tools/cli.md "Command Line Interface"
+[migrating-from-roam]: ../../user/recipes/migrating-from-roam.md "Migrating from Roam (stub)"
+[migrating-from-obsidian]: ../../user/recipes/migrating-from-obsidian.md "Migrating from Obsidian (stub)"
+[migrating-from-onenote]: ../../user/recipes/migrating-from-onenote.md "Migrating from OneNote"
 [//end]: # "Autogenerated link references"

docs/dev/proposals/wikilinks-in-foam.md

@@ -0,0 +1,93 @@
+# Wikilinks in Foam
+
+Foam supports standard wikilinks in the format `[[wikilink]]`.
+
+Wikilinks can refer to any note or attachment in the repo: `[[note.md]]`, `[[doc.pdf]]`, `[[image.jpg]]`.
+
+The usual wikilink syntax without extension refers to notes: `[[wikilink]]` and `[[wikilink.md]]` are equivalent.
+
+The goal of wikilinks is to uniquely identify a file in a repo, no matter in which directory it lives.
+
+Sometimes in a repo you can have files with the same name in different directories.
+Foam allows you to identify those files using the minimum effort needed to disambiguate them.
+
+This is achieved by adding as many directories above the file needed to uniquely identify the link, e.g. `[[house/todo]]`.
+
+See below for more details.
+
+## Goals for wikilinks in Foam
+
+Wikilinks in Foam are meant to satisfy the following:
+- make it easy for users to identify a resource
+- make it interoperable with other similar note taking systems (Obsidian, Dendron, ...)
+- be easy to get started with, but satisfy growing needs
+
+## Types of wikilinks supported in Foam
+
+Foam supports two types of keys inside a wikilink: a **path** reference and an **identifier** reference:
+
+- `[[./file]]` and `[[../to/another/file]]` are **path** links to a resource, relative _from the source_
+- `[[/path/to/file]]` is a **path** link to a resource, relative _from the repo root_
+- `[[file]]` is an **identifier** of a resource (based on the filename)
+- `[[path/to/file]]` is an **identifier** of a resource (based on the path), the same is true for `[[to/file]]`
+
+It's important to note that sometimes identifier keys can't uniquely locale a resource.
+
+A more concrete example will help:
+
+```
+/
+  projects/
+    house/
+      todo.md
+    buy-car/
+      todo.md
+      cars.md
+  work/
+    todo.md
+    notes.md
+```
+
+In the above repo:
+
+- `[[cars]]` is a unique identifier of a resource - it can be used anywhere in the repo
+- `[[todo]]` is an non-unique identifier as it can refer to multiple resources
+- `[[house/todo]]` is a unique identifier of a resource - it can be used anywhere in the repo
+- `[[projects/house/todo]]` is a unique identifier of a resource - it can be used anywhere in the repo
+- `[[/projects/house/todo]]` is a path reference to a resource
+- `[[./todo]]` is a path reference to a resource (e.g. from `/projects/buy-car/cars.md`)
+
+Basically we could say as a rule:
+
+- if the link starts with `/` or `.` we consider it a **path** reference, in the first case from the repo root, otherwise from the source note
+- if a link doesn't start with `/` or `.` it is an **identifier**
+  - generally speaking we use the shortest identifier available to identify a resource, **but all are valid**
+    - `[[projects/buy-car/cars]]`, `[[buy-car/cars]]`, `[[cars]]` are all unique identifier to the same resource, and are all valid in a document
+    - the same can be said for `[[projects/house/todo]]` and `[[house/todo]]` - but not for `[[todo]]`, because it can refer to more than one resource
+
+## Compatibility with other apps
+
+| Scenario                    | Obsidian                        | Foam                            |
+| --------------------------- | ------------------------------- | ------------------------------- |
+| 1 `[[notes]]`               | ✔ unique identifier in repo     | ✔ unique identifier in repo     |
+| 2 `[[/work/notes]]`         | ✔ valid path from repo root     | ✔ valid path from repo root     |
+| 3 `[[work/notes]]`          | ✔ valid path from repo root     | ✔ valid identifier in repo      |
+| 4 `[[project/house/todo]]`  | ✔ valid path from repo root     | ✔ valid unique identifier       |
+| 5 `[[/project/house/todo]]` | ✔ valid path from repo root     | ✔ valid path from repo root     |
+| 6 `[[house/todo]]`          | ✔ valid unique identifier       | ✔ valid unique identifier       |
+| 7 `[[todo]]`                | ✘ ambiguous identifier          | ✘ ambiguous identifier          |
+| 8 `[[/house/todo]]`         | ✘ incorrect path from repo root | ✘ incorrect path from repo root |
+
+## Non-unique identifiers
+
+We can't prevent non-unique identifiers from occurring in Foam (first and foremost because a file could be edited with another editor) but we can flag them. 
+
+Therefore Foam follows the following strategy instead:
+
+1. there is a clear resolution mechanism (alphabetic) so that if nothing changes a non-unique identifier will always return the same note. Resolution has to be deterministic
+2. a diagnostic entry (warning or error) is showed to the user for non-unique identifiers, so she knows that she's using a "risky" identifier
+   1. The quick resolution for this item will show the available unique identifiers matching the non-unique one
+
+## Thanks 
+
+Thanks to [@memplex](https://github.com/memeplex) for helping with the thinking around this proposal.

docs/dev/publishing-permissions.md

@@ -11,5 +11,5 @@ If you're interested in working on it, please start a conversation in [GitHub is
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: todo.md "Todo"
-[roadmap]: roadmap.md "Roadmap"
+[roadmap]: proposals/roadmap.md "Roadmap"
 [//end]: # "Autogenerated link references"

docs/dev/releasing-foam.md

@@ -0,0 +1,25 @@
+# Releasing Foam
+
+1. Get to the latest code
+   - `git checkout main && git fetch && git rebase`
+2. Sanity checks
+   - `yarn reset`
+   - `yarn test`
+3. Update change log
+   - `./packages/foam-vscode/CHANGELOG.md`
+   - `git add *`
+   - `git commit -m"Preparation for next release"`
+4. Update version
+   - `$ yarn version-extension <version>` (where `version` is `patch/minor/major`)
+5. Package extension
+   - `$ yarn package-extension`
+6. Publish extension
+   - `$ yarn publish-extension`
+7. Update the release notes in GitHub
+   - in GitHub, top right, click on "releases"
+   - select "tags" in top left
+   - select the tag that was just released, click "edit" and copy release information from changelog
+   - publish (no need to attach artifacts)
+8. Announce on Discord
+
+Steps 1 to 6 should really be replaced by a GitHub action...

docs/dev/testing.md

@@ -0,0 +1,130 @@
+# Testing in Foam VS Code Extension
+
+This document explains the testing strategy and conventions used in the Foam VS Code extension.
+
+## Test File Types
+
+We use two distinct types of test files, each serving different purposes:
+
+### `.test.ts` Files - Pure Unit Tests
+
+- **Purpose**: Test business logic and algorithms in complete isolation
+- **Dependencies**: No VS Code APIs dependencies
+- **Environment**: Pure Jest with Node.js
+- **Speed**: Very fast execution
+- **Location**: Throughout the codebase alongside source files
+
+### `.spec.ts` Files - Integration Tests with VS Code APIs
+
+- **Purpose**: Test features that integrate with VS Code APIs and user workflows
+- **Dependencies**: Will likely depend on VS Code APIs (`vscode` module), otherwise avoid incurring the performance hit
+- **Environment**: Can run in TWO environments:
+  - **Mock Environment**: Jest with VS Code API mocks (fast)
+  - **Real VS Code**: Full VS Code extension host (slow but comprehensive)
+- **Speed**: Depends on environment (see performance section below)
+- **Location**: Primarily in `src/features/` and service layers
+
+## Key Principle: Environment Flexibility for `.spec.ts` Files
+
+**`.spec.ts` files use VS Code APIs**, but they can run in different environments:
+
+- **Mock Environment**: Uses our VS Code API mocks for speed
+- **Real VS Code**: Uses actual VS Code extension host for full integration testing
+
+This dual-environment capability allows us to:
+
+- Run specs quickly during development (mock environment)
+- Verify full integration during CI/CD (real VS Code environment)
+- Gradually migrate specs to mock-compatible implementations
+
+## Performance Comparison
+
+| Test Type             | Environment            | Typical Duration | VS Code APIs     |
+| --------------------- | ---------------------- | ---------------- | ---------------- |
+| **`.test.ts`**        | Pure Jest              | fastest          | **No**           |
+| **`.spec.ts` (mock)** | Jest + VS Code Mocks   | fast             | **Yes** (mocked) |
+| **`.spec.ts` (real)** | VS Code Extension Host | sloooooow.       | **Yes** (real)   |
+
+## Running Tests
+
+### Available Commands
+
+- **`yarn test:unit`**: Runs `.test.ts` files (no VS Code dependencies) + `@unit-ready` marked `.spec.ts` files using mocks
+- **`yarn test:unit-without-specs`**: Runs only `.test.ts` files
+- **`yarn test:e2e`**: Runs all `.spec.ts` files in full VS Code extension host
+- **`yarn test`**: Runs both unit and e2e test suites sequentially
+
+## Mock Environment Migration
+
+We're gradually enabling `.spec.ts` files to run in our fast mock environment while maintaining their ability to run in real VS Code.
+
+### The `@unit-ready` Annotation
+
+Spec files marked with `/* @unit-ready */` can run in both environments:
+
+```typescript
+/* @unit-ready */
+import * as vscode from 'vscode';
+// ... test uses VS Code APIs but works with our mocks
+```
+
+### Common Migration Fixes
+
+**Configuration defaults**: Our mocks don't load package.json defaults
+
+```typescript
+// Before
+const format = getFoamVsCodeConfig('openDailyNote.filenameFormat');
+
+// After (defensive)
+const format = getFoamVsCodeConfig(
+  'openDailyNote.filenameFormat',
+  'yyyy-mm-dd'
+);
+```
+
+**File system operations**: Ensure proper async handling
+
+```typescript
+// Mock file operations are immediate but still async
+await vscode.workspace.fs.writeFile(uri, content);
+```
+
+### When NOT to Migrate
+
+Some specs should remain real-VS-Code-only:
+
+- Tests verifying complex VS Code UI interactions
+- Tests requiring real file system watching with timing
+- Tests validating extension packaging or activation
+- Tests that depend on VS Code's complex internal state management
+
+## Mock System Capabilities
+
+Our `vscode-mock.ts` provides comprehensive VS Code API mocking:
+
+## Contributing Guidelines
+
+When adding new tests:
+
+1. **Choose the right type**:
+
+   - Use `.test.ts` for pure business logic with no VS Code dependencies
+   - Use `.spec.ts` for anything that needs VS Code APIs
+
+2. **Consider mock compatibility**:
+
+   - When writing `.spec.ts` files, consider if they could run in mock environment
+   - Add `/* @unit-ready */` if the test works with our mocks
+
+3. **Follow naming conventions**:
+
+   - Test files should be co-located with source files when possible
+   - Use descriptive test names that explain the expected behavior
+
+4. **Performance awareness**:
+   - Prefer unit tests for business logic (fastest)
+   - Use mock-compatible specs for VS Code integration (fast)
+   - Reserve real VS Code specs for complex integration scenarios (comprehensive)
+
+This testing strategy gives us the best of both worlds: fast feedback during development and comprehensive integration verification when needed.

docs/dev/todo.md

@@ -14,6 +14,6 @@ Features belong on the [[roadmap]].
 For more things to do, check backlinks for Pages that annotate [[todo]].
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[roadmap]: roadmap.md "Roadmap"
+[roadmap]: proposals/roadmap.md "Roadmap"
 [todo]: todo.md "Todo"
 [//end]: # "Autogenerated link references"

docs/dev/unlinked-references.md

@@ -6,15 +6,15 @@ If you're interested in working on it, please start a conversation in [GitHub is
 
 ## Notes
 
-One of Roam's big features is the ability to find all instances of a reference, create a page for it and update all the references to link to the new page.
+One of Foam's big features is the ability to find all instances of a reference, create a page for it and update all the references to link to the new page.
 
 Implementing this is on the [[roadmap]], but for the time being you can achieve similar things by:
 
 - `Cmd` + `Shift` + `F` ( `Ctrl` + `Shift` + `F` on Windows ) to find all the references, e.g. "Cat food"
-- `Cmd` + `Shift` + `H` ( `Ctrl` + `Shift` + `F` on Windows ) to replace them with [[cat-food]].
+- `Cmd` + `Shift` + `H` ( `Ctrl` + `Shift` + `H` on Windows ) to replace them with [[cat-food]].
 - Click any of the references to create a new note.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: todo.md "Todo"
-[roadmap]: roadmap.md "Roadmap"
+[roadmap]: proposals/roadmap.md "Roadmap"
 [//end]: # "Autogenerated link references"

docs/feature-comparison.md

@@ -1,3 +0,0 @@
-# Feature comparison
-
-- In order to understand what is needed, would be good to have a comparison.

docs/foam-file-format.md

@@ -1,22 +0,0 @@
-# Foam File Format
-
-This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for mediawiki-style `[[wiki-links]]`.
-
-Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wiki-links]]`:
-
-- **It needs to have a single top level `# Heading`.**
-  - This will be used as document title.
-    - [[decision-needed]] Do we need it?
-    - [[decision-needed]] How much to deviate from just markdown
-- **File name should not contain spaces,** e.g. `foam-file-format.md` is a valid name, but `Foam File Format.md` is not.
-  - This is a temporary limitation and will be lifted in future versions.
-  - Technically this actually works already, but may have some edge cases you don't want to deal with if you can avoid it.
-- **File name should have extension `.md` or `.markdown`**
-  - This is a temporary limitation and will be lifted in future versions.
-  - At least `.mdx` will be supported, but ideally we'll support any file that you can map to `Markdown` language mode in VS Code
-- **In addition to normal Markdown Links syntax you can use `[[media-wiki]]` links.** See [[wiki-links]] for more details.
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[decision-needed]: decision-needed.md "Decision Needed"
-[wiki-links]: wiki-links.md "Wiki Links"
-[//end]: # "Autogenerated link references"

docs/foam-gatsby-template.md

@@ -1,25 +0,0 @@
-# Foam Gatsby Template
-
-You can use [foam-gatsby-template](https://github.com/mathieudutour/foam-gatsby-template) to generate a static site to host it online on Github or [Vercel](https://vercel.com). 
-
-## Publishing your foam to Github pages
-It comes configured with Github actions to auto deploy to Github pages when changes are pushed to your main branch.
-
-## Publishing your foam to Vercel
-
-When you're ready to publish, run a local build.
-```bash
-cd _layouts
-npm run build
-```
-
-Remove `public` from your .gitignore file then commit and push your public folder in `_layouts` to Github.
-
-Log into your Vercel account. (Create one if you don't have it already.)
-
-Import your project. Select `_layouts/public` as your root directory and click **Continue**. Then name your project and click **Deploy**.
-
-That's it! 
-
-
-

docs/foam-linter.md

@@ -1,11 +0,0 @@
-# Foam Linter (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.**
-
-If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
-
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[roadmap]: roadmap.md "Roadmap"
-[//end]: # "Autogenerated link references"

docs/foam-local-plugins.md

@@ -1,58 +0,0 @@
-# Foam Local Plugins
-
-Foam can use workspace plugins to provide customization for users.
-
-## ATTENTION
-
-This feature is experimental and its API subject to change.
-**Local plugins can execute arbitrary code on your machine** - ensure you trust the content of the repo.
-
-## Goal
-
-Here are some of the things that we could enable with local plugins in Foam:
-- extend the document syntax to support roam style attributes (e.g. `stage:: seedling`)
-- automatically add tags to my notes based on the location in the repo (e.g. notes in `/areas/finance` will automatically get the `#finance` tag)
-- add a new CLI command to support some internal use case or automate import/export
-- extend the VSCode experience to support one's own workflow, e.g. weekly note, templates, extra panels, foam model derived TOC, ... all without having to write/deploy a VSCode extension
-
-## How to enable local plugins
-
-Plugins can execute arbitrary code on the client's machine.
-For this reason this feature is disabled by default, and needs to be explicitly enabled.
-
-To enable the feature:
-- create a `~/.foam/config.json` file
-- add the following content to the file
-```
-{
-	"experimental": {
-		"localPlugins": {
-			"enabled": true
-		}
-	}
-}
-```
-
-For security reasons this setting can only be defined in the user settings file.
-(otherwise a malicious repo could set it via its `./foam/config.json`)
-
-- [[todo]] an additional security mechanism would involve having an explicit list of whitelisted repo paths where plugins are allowed. This would provide finer grain control over when to enable or disable the feature.
-
-
-## Technical approach
-
-When Foam is loaded it will check whether the experimental local plugin feature is enabled, and in such case it will:
-- check `.foam/plugins` directory.
-	- each directory in there is considered a plugin
-	- the layout of each directory is
-		- `index.js` contains the main info about the plugin, specifically it exports:
-			- `name: string` the name of the plugin
-			- `description?: string` the description of the plugin
-			- `graphMiddleware?: Middleware` an object that can intercept calls to the Foam graph
-			- `parser?: ParserPlugin` an object that interacts with the markdown parsing phase
-
-Currently for simplicity we keep everything in one file. We might in the future split the plugin by domain (e.g. vscode, cli, core, ...)
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo.md "Todo"
-[//end]: # "Autogenerated link references"

docs/frequently-asked-questions.md

@@ -1,19 +0,0 @@
-# Frequently Asked Questions
-
-> ⚠️ Foam is still in preview. Expect the experience to be a little rough.
-
-- [Frequently Asked Questions](#frequently-asked-questions)
-  - [Links/Graphs/BackLinks don't work. How do I enable them?](#linksgraphsbacklinks-dont-work-how-do-i-enable-them)
-
-## Links/Graphs/BackLinks don't work. How do I enable them?
-
-- Ensure that you have all the [[recommended-extensions]] installed in Visual Studio Code
-- Reload Visual Studio Code by running `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "reload" and run the **Developer: Reload Window** command to for the updated extensions take effect
-- Check the formatting rules for links on [[foam-file-format]], [[wiki-links]] and [[link-formatting-and-autocompletion]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
-[foam-file-format]: foam-file-format.md "Foam File Format"
-[wiki-links]: wiki-links.md "Wiki Links"
-[link-formatting-and-autocompletion]: link-formatting-and-autocompletion.md "Link Formatting and Autocompletion"
-[//end]: # "Autogenerated link references"