Commit graph

10 commits

Author SHA1 Message Date
Chris Sells
3198395a32 docs(ci): add Mintlify preview, docsync guard, and broken-links workflow
- mint.sh + make docs-dev: local preview of the docs/ Mintlify site
  (Node 22 handling modeled on the Gas City wrapper).
- test/docsync: Go guard keeping docs/ and docs.json in exact
  correspondence — every nav entry has a file, every page is in the nav
  (tiny stub allowlist for paths released bd binaries print), published
  pages use root-relative extensionless links that resolve, and engdocs/
  plus curated root markdown keep exact GitHub-style paths. Wired into
  make check-docs.
- .github/workflows/docs-mintlify.yml: docsync + baseline-aware
  mint broken-links check on PRs touching docs/**.
- Retire scripts/sync-website-docs.sh and its mirror-drift gate: the six
  mirrored files now live once in the Mintlify site; the committed
  Docusaurus mirrors stay frozen so the parallel-run site keeps building.
- Repoint inbound links to moved docs across README, guides, examples,
  npm-package, plugin resources, and Go comments; add docs/SYNC_CONCEPTS.md
  pointer stub (bd's agent templates print that path). Runtime strings in
  cmd/bd (prime.go, store_factory_nocgo.go, init_git_hooks.go) still print
  old paths — covered by stubs, flagged in the PR.
2026-07-12 10:37:07 -07:00
Julian Knutsen
1a50b5f8c1
docs(security): warn users about malicious "fix" attachment spam (#4652)
Adds an advisory to SECURITY.md covering the automated spam campaign that
attaches malware archives (e.g. bd_fix_v1.zip) to issue comments via
GitHub's user-attachments uploader. Part of an org-wide response.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-07 14:15:51 -07:00
matt wilkie
e2e4975044
Document supported go install modes (bd-o5a) (#3480)
- Removed bare first-party go install .../cmd/bd@latest guidance from docs,
    website docs, plugin/npm docs, examples, and doctor hints.
  - Standardized on:
      - CGO_ENABLED=0 go install ... for server-mode only
      - CGO_ENABLED=1 GOFLAGS=-tags=gms_pure_go go install ... for embedded-
        capable
  - Added scripts/check-go-install-guidance.sh and wired it into CI.
  - Updated default.nix to use gms_pure_go instead of ICU flags.

  Validation passed locally:

  - make test
  - golangci-lint run --build-tags=gms_pure_go ./...
  - ./scripts/check-go-install-guidance.sh
  - ./scripts/check-build-tags.sh
  - go test -tags gms_pure_go ./cmd/bd/doctor
  - doc flag check
2026-04-25 11:30:19 -07:00
matt wilkie
b8ec14d29c
fix: surface auto-export and auto-backup errors to stderr (#3122)
* fix: make auto-export and auto-backup errors visible on stderr

Previously, failures in auto-export (JSONL flush) and auto-backup were
logged only via debug.Logf, invisible to normal users. One user lost 46
issues because JSONL export silently stopped working with no warnings.

Upgrade critical error paths from debug.Logf to fmt.Fprintf(os.Stderr)
so users see warnings when their backup/export pipeline breaks. Keep
debug.Logf for non-critical diagnostics (throttle, no-change skip).

Closes #2489

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* docs: remove stale sync references

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-07 20:37:13 -07:00
Harry
ac4ee4a374 Expand SECURITY.md with tracker integration trust model
Add documentation for:
- Trust boundary: all external tracker data treated as untrusted
- Content sanitization (ANSI stripping, response size limits)
- Credential handling: recommend platform-native auth over plaintext tokens
- Sync security model: user-initiated only, no daemons or webhooks
- AI agent content safety: prompt injection awareness
- Dependency pinning via go.sum

Fixes: bd-68o

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-03-30 09:13:14 -07:00
emma
468c8630be fix: Windows Dolt server lifecycle — stale state files and false auto-stop warning (GH#2670)
Introduce ErrServerNotRunning sentinel so callers can distinguish "already
stopped" from real failures. Stop now cleans up leftover PID/port files even
when the server is not running, preventing bd dolt status from reporting stale
state. Consolidate IsAutoStartDisabled into a single exported function covering
both env var and config sources.

PR: #2740

Co-Authored-By: Harry Miller <harry-miller-trimble@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-21 12:31:20 -07:00
Pablo LION
133741ed8e docs: add network/privacy section to SECURITY.md
Dolt phones home to doltremoteapi.dolthub.com for metrics collection
even with no remotes configured. Document this behavior and provide
two methods to disable it so users can make informed privacy decisions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-04 11:21:29 +01:00
beads/crew/elinor
90da8f6028 docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4)
Replace JSONL storage/sync references with Dolt-native equivalents across
documentation, plugin resources, website docs, agent instructions, and
example READMEs. Preserves legitimate JSONL references (bd import/export
commands, CHANGELOG history, routes.jsonl/interactions.jsonl concepts).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-22 22:18:02 -08:00
emma
4103785ef3 docs: update stale SQLite references to Dolt across 10 documentation files
Major updates:
- ARCHITECTURE.md: Rewrote three-layer model to two-layer (Dolt + JSONL),
  updated all diagrams, directory structure, and code paths
- FAQ.md: Updated database references, dependencies, corruption FAQ
- TROUBLESHOOTING.md: Updated database corruption recovery, locking advice
- WORKTREES.md: Updated directory structure and concurrency references
- MULTI_REPO_HYDRATION.md: Added deprecation notice (SQLite-era feature)
- daemon-summary.md: Added migration note

Path updates:
- PERFORMANCE_TESTING.md: sqlite → dolt benchmark paths
- ADAPTIVE_IDS.md: sqlite → dolt implementation paths
- INTERNALS.md: sqlite → dolt implementation paths
- SECURITY.md: SQLite → Dolt in dependency and storage references

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Executed-By: beads/crew/emma
Rig: beads
Role: crew
2026-02-16 01:22:58 -08:00
Steve Yegge
19cd7d1887 Prepare for public launch: comprehensive examples, docs, and tooling
This commit adds everything needed for a successful public launch:

**New Documentation**
- SECURITY.md: Security policy and best practices
- CLAUDE.md: Complete agent instructions for contributing to beads
- Enhanced README with pain points, FAQ, troubleshooting sections
- Added Taskwarrior to comparison table with detailed explanation

**Installation**
- install.sh: One-liner installation script with platform detection
- Auto-detects OS/arch, tries go install, falls back to building from source
- Updated README with prominent installation instructions

**Examples** (2,268+ lines of working code)
- examples/python-agent/: Full Python implementation of agent workflow
- examples/bash-agent/: Shell script agent with colorized output
- examples/git-hooks/: Pre-commit, post-merge, post-checkout hooks with installer
- examples/claude-desktop-mcp/: Documentation for future MCP server integration
- examples/README.md: Overview of all examples

**Dogfooding**
- Initialized bd in beads project itself (.beads/beads.db)
- Created issues for roadmap (MCP server, migrations, demos, 1.0 milestone)
- Exported to .beads/issues.jsonl for git versioning

**Visual Assets**
- Added screenshot showing agent using beads to README intro
- Placed in .github/images/ following GitHub conventions

This addresses all launch readiness items:
✅ Security policy
✅ Working agent examples (Python, Bash)
✅ Git hooks for automation
✅ FAQ addressing skeptics
✅ Troubleshooting common issues
✅ Easy installation
✅ Dogfooding our own tool
✅ Pain points that create urgency

Ready to ship! 🚀

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-12 11:25:29 -07:00