From eca7dc1b1905881cd1d466c742f4b5566c4e8d29 Mon Sep 17 00:00:00 2001 From: phernandez Date: Wed, 4 Nov 2026 18:17:01 -0600 Subject: [PATCH] Remove note formatting docs for the 1.0 removal Core PR basicmachines-co/basic-memory#2057 removes format_on_save, formatter_command, formatters, formatter_timeout, the built-in mdformat formatter, and the bm format command. Drop the Formatter settings section from the configuration reference and the bm format entries from the CLI reference and CLI basics. Note the removal in the 1.0 changelog breaking changes and add a short section to Migrating to 1.0. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01CMYVKyv6fNv5MUtAeTDALb Signed-off-by: phernandez --- content/02.whats-new/06.changelog.md | 2 +- content/07.local/3.cli-basics.md | 8 ------- content/11.reference/1.cli-reference.md | 15 ------------ content/11.reference/6.configuration.md | 28 ---------------------- content/11.reference/7.migrating-to-1-0.md | 9 +++++++ 5 files changed, 10 insertions(+), 52 deletions(-) diff --git a/content/02.whats-new/06.changelog.md b/content/02.whats-new/06.changelog.md index ea93511..8e22f7c 100644 --- a/content/02.whats-new/06.changelog.md +++ b/content/02.whats-new/06.changelog.md @@ -13,7 +13,7 @@ In Basic Memory Cloud, every project opens as a [Wiki](/cloud/wiki), with an ove In the core package, the MCP server moves to the 1.0 `bm_*` tools: twelve tools such as `bm_read`, `bm_write`, `bm_edit`, `bm_search`, and `bm_context`, plus an opt-in `bm_project_delete`, with typed refusals and a manual page for each. `bm doctor` becomes a read-only report on your real projects, with the command that fixes each problem, and a `memory-doctor` skill walks an agent through it. Fixes cover watching newly created projects, large vector deletions and interrupted migrations on SQLite, and a stale storage read that could roll a note back to an older version. FastAPI is upgraded past the v0.24.1 pin. -Breaking changes: the MCP tools are renamed and their arguments change, and with several projects, note and search tools need an explicit project. Read [Basic Memory 1.0](/whats-new/basic-memory-1-0) for the highlights and [Migrating to 1.0](/reference/migrating-to-1-0) before switching clients. +Breaking changes: the MCP tools are renamed and their arguments change; with several projects, note and search tools need an explicit project; and note formatting is removed (`format_on_save`, `formatter_command`, `formatters`, `formatter_timeout`, and `bm format`). Read [Basic Memory 1.0](/whats-new/basic-memory-1-0) for the highlights and [Migrating to 1.0](/reference/migrating-to-1-0) before switching clients. --- diff --git a/content/07.local/3.cli-basics.md b/content/07.local/3.cli-basics.md index 61ffa42..006c74b 100644 --- a/content/07.local/3.cli-basics.md +++ b/content/07.local/3.cli-basics.md @@ -105,14 +105,6 @@ bm schema diff person Infer a schema from existing notes, validate notes against it, and detect drift — see the [Schema System](/concepts/schema-system) for concepts and the full workflow. -## Format files - -```bash -bm format -bm format --project research -bm format notes/meeting.md -``` - ## Next steps :::card-group diff --git a/content/11.reference/1.cli-reference.md b/content/11.reference/1.cli-reference.md index 0b34dfc..c2b0b07 100644 --- a/content/11.reference/1.cli-reference.md +++ b/content/11.reference/1.cli-reference.md @@ -197,21 +197,6 @@ bm update --check Auto-update behavior is configurable — see [Configuration](/reference/configuration) for the `auto_update` and `update_check_interval` settings. :: -### `bm format` - -Format files using configured formatters. Uses the `formatter_command` or `formatters` settings from your config. By default, formats all `.md`, `.json`, and `.canvas` files in the current project. - -```bash -bm format # Format all files in current project -bm format --project research # Format files in specific project -bm format notes/meeting.md # Format a specific file -bm format notes/ # Format all files in a directory -``` - -| Flag | Description | -|------|-------------| -| `--project`, `-p` | Target a specific project | - --- ## Shell-style read commands diff --git a/content/11.reference/6.configuration.md b/content/11.reference/6.configuration.md index 814512a..87bb29e 100644 --- a/content/11.reference/6.configuration.md +++ b/content/11.reference/6.configuration.md @@ -472,34 +472,6 @@ Timestamp of the last automatic update check. Managed automatically — you don' --- -## Formatter settings - -### `format_on_save` - -Automatically format notes when they are saved via `write_note` or `edit_note`. With no `formatter_command` configured, markdown is formatted by the built-in mdformat; setting a command (or the per-extension `formatters` map) overrides it with an external tool. - -- Type: boolean -- Default: `false` -- Env: `BASIC_MEMORY_FORMAT_ON_SAVE` - -### `formatter_command` - -External command to use for formatting markdown files. The file path is substituted via a `{file}` placeholder — for example `npx prettier --write {file}`. A per-extension `formatters` map is also available for different tools per file type. - -- Type: string | null -- Default: `null` -- Env: `BASIC_MEMORY_FORMATTER_COMMAND` - -### `formatter_timeout` - -Maximum time in seconds to wait for the formatter command to complete. - -- Type: float -- Default: `5.0` -- Env: `BASIC_MEMORY_FORMATTER_TIMEOUT` - ---- - ## Database settings ### `database_backend` diff --git a/content/11.reference/7.migrating-to-1-0.md b/content/11.reference/7.migrating-to-1-0.md index e19c20d..646ff5a 100644 --- a/content/11.reference/7.migrating-to-1-0.md +++ b/content/11.reference/7.migrating-to-1-0.md @@ -83,3 +83,12 @@ Use `bm_man(page="bm-search(3)")` or `bm man bm-search` for the installed refere Re-run benchmark baselines after upgrading; historical results describe the tool surface they were measured against and should not be relabeled as 1.0 results. +## Note formatting is removed + +1.0 no longer formats notes when they are saved. The `format_on_save`, `formatter_command`, +`formatters`, and `formatter_timeout` settings, their `BASIC_MEMORY_*` environment variables, +and the `bm format` command are gone, along with the built-in mdformat formatter. + +A `config.json` that still has these keys keeps loading; the keys are ignored. Delete them +when convenient. To keep notes formatted, run your formatter (for example Prettier) over the +project folder yourself, outside Basic Memory.