beads/docs/reference
Vishnu J c5e49a3b78
docs(config): document audit.enabled in configuration reference (#5940)
The optional JSONL interaction sidecar at .beads/interactions.jsonl is
gated behind audit.enabled (default false, internal/config/config.go:245)
with a BD_AUDIT_ENABLED env override (internal/audit/audit.go:67-72), but
the key is absent from docs/reference/configuration.md, so there is no
documented way to discover it outside `bd audit` help text.

Two changes, both on the same page:

- Add an `audit.enabled` row to the Tool-Level Settings table covering the
  default, the env var, what enabling it does, the fact that both
  `bd audit record` and `bd audit label` refuse to write while it is off
  (both go through audit.AppendIfEnabled -- cmd/bd/audit.go:103 and :146),
  and the fact that issue history is recorded in the database regardless.
- Add `audit.*` and `storage-class.*` to the list of namespaces routed to
  config.yaml. Both are in config.IsYamlOnlyKey's prefix list
  (internal/config/yaml_config.go:118) but were missing from the doc; the
  list now matches that prefix list exactly.

Reported by @treystout in #5904.
2026-09-02 18:11:08 -07:00
..
advanced.md docs(events): document the events journal and bd events (bd-opisf) 2026-08-09 01:58:17 +00:00
antivirus.md docs: apply PR #4722 review feedback to user docs 2026-07-12 11:06:57 -07:00
configuration.md docs(config): document audit.enabled in configuration reference (#5940) 2026-09-02 18:11:08 -07:00
events-journal.md feat(events-journal): record the mutating actor on every journal row (#5908) 2026-08-23 13:55:59 -07:00
faq.md docs(troubleshooting): document the two native-Windows integration traps (#5838) 2026-08-20 05:41:39 -07:00
git-integration.md fix: reject incompatible timeout in generated hooks (#5522) 2026-08-10 20:47:53 -07:00
index.md docs(events): document the events journal and bd events (bd-opisf) 2026-08-09 01:58:17 +00:00
json-schema.md docs: re-review and bump the three 90-day-stale freshness markers (#5394) 2026-08-07 02:35:11 -07:00
observability.md refactor(telemetry): adopt standard OTel SDK env vars with BD_OTEL_* back-compat (#3859) 2026-08-03 00:05:06 -07:00
protected-branches.md docs: apply PR #4722 review feedback to user docs 2026-07-12 11:06:57 -07:00
troubleshooting.md docs: pin the Dolt version instead of steering users to releases/latest (ga-m0dlk) (#5899) 2026-08-20 22:41:24 -07:00
worktrees.md docs: apply PR #4722 review feedback to user docs 2026-07-12 11:06:57 -07:00