Bun DocsAbout this site
Community identity, sources, editorial principles, update policy, and corrections for Bun Docs
Last updated on
Community identity
Bun Docs is a community-maintained practical knowledge base. It is not affiliated with Bun, Oven, or their commercial partners. The “Official Bun” navigation item explicitly leads to bun.com.
The site does not mirror the official API reference. It provides task-oriented guidance for onboarding, migration, cloud deployment, AI applications, and coding agents. Precise APIs, support status, and security behavior defer to the linked first-party source.
Editorial principles
- Query interfaces first: verify commands, configuration keys, and platform capabilities against current official documentation.
- Separate facts from advice: cite verifiable behavior and state the boundary of operational recommendations.
- Do not invent compatibility: local success does not prove production support for a framework, platform, or native dependency.
- Keep bilingual parity: Chinese and English use the same slugs and topic scope while retaining native writing.
- Put safety first: document risk around install scripts, secrets, tool calls, production writes, and agent authority.
- Stay reproducible: examples include prerequisites, observable outcomes, and verification rather than fictional placeholder APIs.
Source hierarchy
| Priority | Source | Used for |
|---|---|---|
| 1 | Bun documentation and API reference | Runtime, package manager, test, bundler, and deployment facts |
| 2 | Official cloud, framework, and SDK documentation | Platform boundaries, support status, and integrations |
| 3 | Primary standards and security authorities | HTTP, containers, search, and security requirements |
| 4 | Community material | Discovering issues, never the sole source for a critical claim |
Updates and corrections
Each page shows its own last-verified date at the bottom. Pages with an individual fact review display their lastVerified date; the rest display the corpus-wide review date, currently 2026-08-02. Review the affected guide again when:
- a stable Bun release changes default behavior;
- a cloud platform changes its Bun runtime support;
- an SDK, framework, or deployment adapter is upgraded;
- a security advisory affects an example dependency or recommendation;
- a reader provides reproducible evidence of an error.
Once NEXT_PUBLIC_REPO_URL points at a public source repository, every docs page shows a GitHub edit link in its footer; while unset, the link stays hidden to avoid implying an affiliation. A useful correction report includes the page URL, Bun version, minimal reproduction, and first-party evidence.
Search and machine access
HTML pages are canonical for search. .md, llms.txt, and llms-full.txt exist for agents and offline indexing. They remain directly readable while using X-Robots-Tag to prevent duplicate search results.