thymer docs
Documentation/Markdown Mirror/Link a collection into a project folder

Link a collection into a project folder

Your projects have their own folders on your computer, and that’s where you and your agents work. The mirror has a folder of its own. A link brings them together: the project’s documentation lives in a Thymer collection, and the same files show up as a folder inside the project.

Say the mirror is in /Users/me/Documents/Thymer Markdown Mirror, and the workspace has a collection called ProjectA Docs. Link its folder into the project:

ln -s "/Users/me/Documents/Thymer Markdown Mirror/ProjectA Docs" \
  /Users/me/ProjectA/Documentation

/Users/me/ProjectA/Documentation now holds the collection’s pages as Markdown files. An agent working on ProjectA reads and edits them like any other file in the project, without knowing anything about Thymer. While the mirror runs, what you or your team change in Thymer shows up in the project’s folder, and what the agent changes shows up in Thymer.

On macOS and Linux, run ln -s in a terminal, as above: the collection’s folder first, then the new folder in the project. A Finder alias won’t do, because agents and command-line tools don’t follow it.

On Windows, make a junction in Command Prompt. It needs no administrator rights, and the new folder comes first:

mklink /J "C:\Users\me\ProjectA\Documentation" ^
  "C:\Users\me\Documents\Thymer Markdown Mirror\ProjectA Docs"

Link from the project into the mirror, not the other way around. The mirror doesn’t follow links inside its own folder, and its folder can’t be a link itself.

Good to know

  • Many search tools skip a linked folder when they search a whole project. Tell the agent where the documentation is, for example in the project’s instructions for agents: “The documentation is in Documentation/.”
  • Renaming the collection renames its folder, and the link then points nowhere. Make it again with the new name.
  • In a Git repository, Git stores the link instead of the pages, and on other computers it points nowhere. Add /Documentation to .gitignore, and let each teammate link their own mirror.

What the agent can see

An agent that stays in the project sees this one collection, not the whole workspace. That keeps it focused, but a link isn’t a lock: the agent can see where it points, and on macOS and Linux, .. from inside the linked folder leads to the mirror folder and the other collections. To keep an agent out of the rest of the workspace, use its own sandbox or permission settings and allow only the collection’s folder. Some sandboxes check where a link really points, and block the folder as outside the project until you allow it.