docs

Featured

Read, edit, or save documents in BB Docs vaults, including documents supplied through Docs mentions.

Data & Documents 3,934 stars 552 forks Updated today MIT

Install

View on GitHub

Quality Score: 87/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Docs Docs is the user's filesystem-first document library. Documents can live on the server machine or another connected host, but the `bb docs` command handles that routing through named vaults. ## Access documents Start with the smallest useful lookup: ```sh bb docs vaults --json bb docs list --vault <vault-id> --json bb docs read <path> --vault <vault-id> ``` Use the path and vault exactly as returned. Paths are relative to the vault; do not guess an absolute host path or inspect the vault outside `bb docs`. ## Docs @-mentions A Docs mention resolves at send time and appears in agent context as a `Docs document (<vault>/<path>)` block. Treat that block as user-provided source material from their document library: - Read and use its current contents even if the prompt only says “this” or “the attached doc.” - Preserve its meaning and distinguish its claims from your own inference. - Do not rewrite the mentioned document unless the user asks you to change it. - When your answer refers the user back to it, emit a Docs directive rather than an opaque filesystem path. ## Create and update documents Docs is a good destination for durable plans, specifications, write-ups, and HTML artifacts the user should be able to reopen. ```sh bb docs pull plans/release-plan.md --vault personal --into ./docs-work # Edit ./docs-work/plans/release-plan.md with normal file tools. bb docs status ./docs-work --diff bb docs push ./docs-work ``` `bb docs status` exits 0 when no cha...

Details

Author
get-bb
Repository
get-bb/bb
Created
7 months ago
Last Updated
today
Language
TypeScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

docs

Access and update the user's Docs vaults. Use whenever the user asks to read, find, create, update, or store a note, document, plan, or HTML artifact; when a Docs @-mention appears in context; or when an answer should link to a document the user can open in Docs.

2 Updated 1 weeks ago
laruss
Data & Documents Listed

docs

Write and maintain project documentation under docs/generated/ — /docs write creates or updates a doc on a topic, /docs check reports stale content, broken code references, and orphan files. Use when the user wants to capture the design intent behind a feature, record an architectural decision, or verify existing docs still match the code. Docs use [symbol](file-path) reference pointers instead of inline code blocks.

18 Updated 1 months ago
2ykwang
Data & Documents Listed

docs-structure

Check, build and fill a repository's Markdown documentation from what the repository actually contains. Read-only by default - reports which docs a repo needs (derived from its code, configs and history, not a fixed list), which existing doc covers each concern whatever its file name, and what is unreachable, oversized, dead-linked or cited by line number. On request it lays down skeleton docs for uncovered concerns and drafts them sentence by sentence from repo evidence with the source in brackets, marked for review. Use for docs layout, a docs index, orphaned or oversized docs, splitting a big doc, owner lines, setting up docs for a new repo, or drafting an architecture, deployment, data-model or API doc from the repo. Not for whether existing prose is still true or has missed a code change (use docs-sync-audit) and not for source-code structure (use repo-health-audit).

1 Updated 1 weeks ago
specialone0007