Repositories and paths
An installation’s repositories sit side by side. Acme has two:
| Repository | Summary |
|---|---|
handbook |
How Acme works: onboarding, processes and policies. |
projects |
One folder per project: plans, decisions and meeting notes. |
repo and path
Every basic tool takes the repository as a field of its own, repo, and a
path relative to that repository:
{ "repo": "projects", "path": "active/launch/decisions/pick-a-date.md" }
The tool list names the repositories the person can read as the allowed
values of repo, each with its summary. So the model knows which
repositories there are, and what each is for, before its first call.
Listing, searching and searching the history may leave repo out to work
across every readable repository at once. Their answers then name each note
as <repo>/<path>, for example handbook/onboarding/first-week.md.
Links inside a file stay relative to its own repository. Major Vault never rewrites them.
Plain repositories
A repository without .vault/ is plain Markdown on its default branch,
all of it open. The basic tools work there as they stand, and creating a
note writes a plain file. Nothing else is needed to start.
Configured repositories
A .vault/ folder lets a repository say more about itself:
- its settings: a summary, the folders that belong to the vault, and how its notes are checked;
- its folders, each described by a
README.md; - its note types, which the basic tools check;
- special tools for a workflow of its own.
Major Vault reads .vault/ from the default branch. A push that changes it
reaches the next tool list by itself; nothing has to restart.