Skip to content

Remove note formatting docs for the 1.0 removal - #54

Open
phernandez wants to merge 1 commit into
mainfrom
docs/remove-note-formatting
Open

phernandez wants to merge 1 commit into
mainfrom
docs/remove-note-formatting

Conversation

@phernandez

Copy link
Copy Markdown
Member

Summary

Docs for core PR basicmachines-co/basic-memory#2057, which removes note formatting (breaking change).

Important

Merge only after basicmachines-co/basic-memory#2057 ships. Until then these settings and bm format still exist in released versions.

Changes

  • Configuration reference (content/11.reference/6.configuration.md): remove the Formatter settings section (format_on_save, formatter_command, formatter_timeout, and the mentions of formatters, mdformat, and Prettier).
  • CLI reference (content/11.reference/1.cli-reference.md): remove the bm format section.
  • CLI basics (content/07.local/3.cli-basics.md): remove the Format files section.
  • Changelog (content/02.whats-new/06.changelog.md): add the removal to the 1.0 breaking-changes line.
  • Migrating to 1.0 (content/11.reference/7.migrating-to-1-0.md): add a short "Note formatting is removed" section: old config keys are ignored, not rejected, and users who want formatting can run their own formatter over the project folder.

No version bump and no new What's New page, since the release hasn't shipped.

Not changed

docs/review-findings.md (internal audit log, not published) still mentions the formatter settings in already-resolved findings. Left as history.

Verification

  • npm run build succeeds.
  • git grep finds no remaining mentions under content/ outside the two breaking-change notes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01CMYVKyv6fNv5MUtAeTDALb

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 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CMYVKyv6fNv5MUtAeTDALb
Signed-off-by: phernandez <paul@basicmachines.co>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-05T00:18:31.901690Z eca7dc1 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant