Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ The site is served at `http://localhost:3000`.
## Contributing

Contributions are welcome. Open an issue or submit a pull request.

Before writing or editing a page, read the [voice guidelines](https://bun.com/docs/project/contributing#voice) (source: `project/contributing.mdx`): short sentences, active voice, present tense, second person, and no "easy", "simple", or "just".
26 changes: 26 additions & 0 deletions docs/project/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -377,3 +377,29 @@
- Disable logging: `BUN_DEBUG_QUIET_LOGS=1 bun-debug ...` (to disable all debug logging)
- Enable logging for a specific scope: `BUN_DEBUG_EventLoop=1 bun-debug ...` (to enable `scoped_log!(EventLoop, ...)` output)
- Bun transpiles every file it runs. To see the actual executed source in a debug build, find it in `/tmp/bun-debug-src/...path/to/file`. For example, the transpiled version of `/home/bun/index.ts` is in `/tmp/bun-debug-src/home/bun/index.ts`

## Contributing to the docs

The docs are the MDX files in `docs/`, published at [bun.com/docs](https://bun.com/docs). To preview your changes, install the [Mintlify CLI](https://www.npmjs.com/package/mint) and run it from the `docs/` directory:

```bash
bun install -g mint
cd docs
mint dev
```

### Voice

Check warning on line 391 in docs/project/contributing.mdx

View check run for this annotation

Claude / Claude Code Review

Missing .claude/docs/landing-prs.md change described in PR body

The PR description says ".claude/docs/landing-prs.md gets a one-line summary of the same rules next to the existing docs-verification bullet", but the diff only touches `docs/README.md` and `docs/project/contributing.mdx` — the `landing-prs.md` hunk is absent. Since `CLAUDE.md` directs agents to read `.claude/docs/landing-prs.md` before touching docs, either add the missing one-liner under the **Docs, types, and comments** section (next to the "Verify every documentation claim you publish" bulle
Comment thread
robobun marked this conversation as resolved.

A docs page describes what Bun does and what you can do with it. Write it so that a developer who is new to Bun can read the page once and act on it. These guidelines are adapted from the [Next.js docs contribution guide](https://nextjs.org/docs/community/contribution-guide#voice):

- Write short sentences that each make one point. If a sentence needs several commas or a parenthetical, split it up or turn it into a list.
- Use plain words: "use" rather than "utilize", "to" rather than "in order to". Cut filler such as "Note that" and "Please".
- Use the active voice and name the actor: "Bun reads `bunfig.toml`", rather than "`bunfig.toml` is read". A sentence built around "is" and "by" is usually passive.
- Describe current behavior in the present tense: "Bun installs the package", rather than "Bun will install the package".
- Name the subject when "this" or "it" could refer to more than one thing: "`--isolate` is how Jest behaves by default", rather than "This is how Jest behaves by default".
- Address the reader as "you", and make Bun (or the specific tool) the other actor: "Bun caches the tarball", rather than "we cache the tarball" or "let's cache the tarball".
- Leave out "easy", "simple", "just", and "quick". They add nothing when a task is easy and discourage readers when it is not. State the concrete property instead: "one command", "no configuration".
- Say what to do rather than what to avoid: "use `port: 0` so the operating system picks a free port", rather than "don't hardcode ports". State limitations plainly; a limitation is a fact, not a warning to the reader.
- Use gender-neutral language: "developers", "users", "they".
- Make link text name its destination: "see [`bun install`](/pm/cli/install)", rather than "see here".
- Run every code example before you publish it, and check option names and defaults against the implementation on `main`.