bd help --docs-root now additionally writes docs/cli-reference/ in Mintlify form (frontmatter title as H1, extensionless root-relative links, JSX auto-generated markers since Mintlify parses .md through MDX) and rewrites the CLI Reference pages array inside docs/docs.json via a textual splice that leaves the rest of the file byte-identical — the ~113 nav entries are never hand-maintained. The Docusaurus outputs (docs/CLI_REFERENCE.md, website/docs/cli-reference/, versioned snapshots) are unchanged. generate-cli-docs.sh --check seeds docs/docs.json and docs/cli-reference/ into its scratch root and diffs both; check-cli-docs-drift.sh adds them to GEN_PATHSPECS and the regeneration fingerprint; docs-autofix-push.sh allowlists the new generated paths; check-doc-flags.sh scans the new docs/ subdirectories and requires command coverage in docs/cli-reference/. Includes the initial docs/docs.json scaffold (nav mirrors the Docusaurus sidebar IA) and the generated docs/cli-reference/ pages. TDD: new emitter behavior covered in cmd/bd/help_all_test.go (Mintlify page format, nav splice correctness + idempotence, bare-root generation without docs.json).
28 lines
934 B
Markdown
28 lines
934 B
Markdown
---
|
|
title: "bd onboard"
|
|
description: "Display minimal snippet for agent instructions file"
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc onboard`.
|
|
|
|
Display a minimal snippet to add to your agent instructions file for bd integration.
|
|
|
|
By default, the agent instructions file is AGENTS.md. Use 'bd init --agents-file'
|
|
to configure a different filename (e.g. BEADS.md).
|
|
|
|
This outputs a small (~10 line) snippet that points to 'bd prime' for full
|
|
workflow context. This is the same minimal profile that 'bd init' generates
|
|
by default. This approach:
|
|
|
|
• Keeps your agent file lean (doesn't bloat with instructions)
|
|
• bd prime provides dynamic, always-current workflow details
|
|
• Hooks auto-inject bd prime at session start
|
|
|
|
For agents or environments that do not auto-inject hook output, use
|
|
'bd init --agents-profile=full' to embed the complete command reference.
|
|
|
|
```
|
|
bd onboard [flags]
|
|
```
|