# CodeCompanion Docs

Writes and edits CodeCompanion.nvim docs pages in the doc folder.

- Repository: https://github.com/olimorris/codecompanion.nvim (6919 stars)
- Category: Documents
- License: Apache-2.0
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add olimorris/codecompanion.nvim --skill writing-docs -g -a claude-code -y`
Codex: `npx skills add olimorris/codecompanion.nvim --skill writing-docs -g -a codex -y`
Cursor: `npx skills add olimorris/codecompanion.nvim --skill writing-docs -g -a cursor -y`
Gemini CLI: `npx skills add olimorris/codecompanion.nvim --skill writing-docs -g -a gemini-cli -y`

## Description

Writing CodeCompanion.nvim docs. Use when creating or editing any page in `doc/`

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Writing Docs

Write CodeCompanion.nvim's docs following the Microsoft Writing Style Guide with the overrides below. Run `make docs` after changing any page to regenerate the vimdoc.

## Voice and Tone

- Write like you speak: friendly, direct and human, aimed at Neovim users. Avoid jargon where a familiar word works.
- Lead with what matters most. Front-load keywords so readers can scan.
- Say what happens, including the edge cases: "Optional arguments can be left blank, and cancelling at any point adds nothing".
- Be brief. Cut filler words, unnecessary adverbs and phrases like "you can", "there is" and "there are" where they add nothing. Prefer one-word verbs ("try", not "attempt to").
- Avoid marketing language and hedging: no "simply", "powerful", "awesome", "seamless" or "journey".
- Start with the content. Don't open with "This guide is intended to help you..." or close with "This is useful for...".

## Page Structure

- Frontmatter `description`: one sentence, what the page lets you do.
- The `#` title is "Using X" for usage pages, "Configuring X" for configuration pages and "Extending with X" for extending pages. Guides take a task title: "Running Local Models", "Choosing an Adapter".
- Open with one to three sentences: what the feature is, then how CodeCompanion does it. If the feature solves a problem, name the problem in a sentence first.
- `##` then `###` is the ceiling. For a sub-point under `###`, use a bold line (`**Images**`) instead of a deeper heading.
- Section names are short nouns or gerunds: "Directories", "Groups", "Autoload", "Editing and Deleting".
- End with a "Limitations" section when there are any, stated honestly.

## Code First

The rhythm is a one-line lead-in ending in a colon, then the code block:

````markdown
Skills are enabled by default. To disable them:

```lua
require("codecompanion").setup({
  skills = {
    opts = {
      chat = {
        enabled = false,
      },
    },
  },
})
```
````

The rest: https://github.com/olimorris/codecompanion.nvim/blob/HEAD/.codecompanion/skills/writing-docs/SKILL.md