Format the rewritten documents with prettier

Re-wraps README.md, docs/ARCHITECTURE.md, docs/DATAMODEL.md,
docs/REPOSTRUCTURE.md and the roadmap in docs/TODO.md with `make fmt`,
which now runs prettier on Markdown. Only line wrapping changes; the
words are those that passed review at 4da102c.

Model: fable-5-1
This commit is contained in:
sneak authored and clawbot committed 2026-11-11 07:01:54 +00:00
1 parent 1128b85653
commit 179af61c68
5 files changed
+104 -110

No files matched your search

+19 -20
View File
@@ -199,12 +199,10 @@ vaultik version
Most commands need these:
- A config file that loads. See [Configuration](#configuration) for the
checks.
- A config file that loads. See [Configuration](#configuration) for the checks.
- Write access to the local index. The command creates the file, and its
directory, when they do not exist.
- For an `rclone://` destination, an rclone config file that defines the
remote.
- For an `rclone://` destination, an rclone config file that defines the remote.
Each command below lists what it needs beyond this.
@@ -212,8 +210,8 @@ These commands need less:
- `completion` and `version` need nothing.
- `config init` needs write access to the config directory.
- `database delete` needs a config file that loads. It does not open the
local index.
- `database delete` needs a config file that loads. It does not open the local
index.
- These need a config file that exists, even an incomplete one:
- `config edit`
- `config get`
@@ -294,8 +292,8 @@ Sets one value in the config file. The key is a dotted path, as in
- A key that does not exist yet is created. A missing parent becomes a list when
the next part of the path is a number, and a map otherwise.
- In a list, the index one past the end appends an entry.
- The command prints the key it set, and not the value. A refusal for a value
of the wrong type quotes the beginning of that value.
- The command prints the key it set, and not the value. A refusal for a value of
the wrong type quotes the beginning of that value.
- It sets the file's mode to `0600` when group or others could read it.
The command refuses a change that would stop the config from loading. An example
@@ -453,8 +451,8 @@ marker file although the local index holds snapshots.
when the destination could not be listed.
Under `--json`, every warning above goes to stderr, except the one about a
snapshot with no manifest at the destination. That snapshot has
`remote_present` set to `false`.
snapshot with no manifest at the destination. That snapshot has `remote_present`
set to `false`.
### `snapshot verify <snapshot-id>`
@@ -786,8 +784,8 @@ It also says when the binary is a development build, not a release.
The config file is YAML. `vaultik config init` writes one to start from, and
[`config.example.yml`](config.example.yml) is a longer example.
A command refuses to start when the config does not load. These commands are
the exceptions:
A command refuses to start when the config does not load. These commands are the
exceptions:
- the `config` commands
- `completion`
@@ -897,8 +895,8 @@ A command that reads the config fails when the path from `--config` or
- Only the part before the first `.` is used.
- `index_path`
- The path of the local index.
- Default: `index.sqlite` in the platform data directory. By default that
is `~/.local/share/vaultik/` on Linux and
- Default: `index.sqlite` in the platform data directory. By default that is
`~/.local/share/vaultik/` on Linux and
`~/Library/Application Support/vaultik/` on macOS.
Sizes take a number of bytes or a unit. `MB` and `GB` are powers of 1000. `MiB`
@@ -1042,9 +1040,9 @@ Commands need these permissions at the destination:
- `remote nuke`
- `prune` and `snapshot create --prune` list, read and delete.
An rclone remote that can move objects also needs permission to read and
delete. An upload there looks up the object it replaces and deletes it. It stops
when the look-up is refused.
An rclone remote that can move objects also needs permission to read and delete.
An upload there looks up the object it replaces and deletes it. It stops when
the look-up is refused.
`snapshot verify` and `snapshot restore` list only when you give a remote key.
`snapshot remove --local-only` does not reach the destination.
@@ -1483,8 +1481,8 @@ Each archive holds three files:
- `LICENSE`
- `README.md`
The release files are not signed, have no software bill of materials and are
not built reproducibly.
The release files are not signed, have no software bill of materials and are not
built reproducibly.
## TODO
@@ -1496,7 +1494,8 @@ Planned work is listed in [`TODO.md`](TODO.md).
## author
Made with love and lots of expensive SOTA AI by [sneak](https://sneak.berlin) in Berlin in the summer of 2025.
Made with love and lots of expensive SOTA AI by [sneak](https://sneak.berlin) in
Berlin in the summer of 2025.
Released as a free software gift to the world, no strings attached.