Update Documentation

Documentation Locations

docs/USER_MANUAL.md

docs/CONFIGURATION.md

docs/TROUBLESHOOTING.md

docs/FAQ.md

README.md

website/news/index.html

~/Documents/markdown-notes/Voxtype/

Writing Style

• No em-dashes (—) - use colons or separate sentences
• No "delve", "leverage", "utilize", "streamline", "robust", "seamless"
• No excessive hedging ("It's worth noting...", "Interestingly...")
• No punchy one-liners ("And that's the point.", "Simple as that.")
• No sentence fragments for effect ("The result? Faster builds.")
• Write plainly and directly

User Manual Updates

docs/USER_MANUAL.md

1. Add to table of contents if significant
2. Create new section with clear heading
3. Include usage examples with code blocks
4. Explain the "why" not just the "how"

Configuration Guide Updates

docs/CONFIGURATION.md

1. Add to the relevant section
2. Show the TOML syntax
3. Document the default value
4. Explain what it does and when to use it

### new_option

Enable the new feature.

```toml
[section]
new_option = true  # default: false

## Troubleshooting Updates

Location: `docs/TROUBLESHOOTING.md`

Format for new issues:

```markdown
### Error: The specific error message

**Cause:** Why this happens

**Solution:**
1. Step one
2. Step two

**Example:**
```bash
command to fix

## Website News Articles

Location: `website/news/index.html`

Every GitHub release needs a matching news article. Follow v0.4.10/v0.4.11 as examples.

Structure:
```html
<article class="news-article" id="v0415">
    <div class="article-meta">
        <time datetime="2026-01-20">January 20, 2026</time>
        <span class="article-tag">Release</span>
    </div>
    <h2>v0.4.15: Feature Summary</h2>
    <div class="article-body">
        <p>Intro paragraph...</p>

        <h3>Feature Name</h3>
        <p>Description.</p>
        <p><strong>Why use it:</strong> User benefit.</p>

        <div class="code-block">
            <div class="code-header"><span>config.toml</span></div>
            <pre><code>[section]
option = "value"</code></pre>
        </div>
    </div>
</article>

GitHub Release Notes

• Title:

  v0.4.15: Feature Summary

• Brief intro paragraph

• ###

  sections for each feature

• **Why use it:**

  callouts
• Bug fixes as bullet list
• Downloads table with checksums

Obsidian Vault Notes

/obsidian

~/Documents/markdown-notes/Voxtype/

• Summary of work completed
• Key decisions and rationale
• Links to PRs/issues
• Next steps

Crediting Contributors

In Commits

Co-authored-by: Name <email@example.com>

In Cargo.toml

authors = [
    "Peter Jackson <pete@peteonrails.com>",
    "Contributor Name <contributor@example.com>",
]

In README

On Website

Release Documentation Checklist

• Update

  docs/USER_MANUAL.md

  for new features
• Update

  docs/CONFIGURATION.md

  for new options
• Update

  docs/TROUBLESHOOTING.md

  for new error conditions
• Add news article to

  website/news/index.html

• Create GitHub release with notes
• Update

  packaging/arch-bin/voxtype-bin.install

  post_upgrade message
• Credit contributors in Cargo.toml and README
• Save session notes to Obsidian vault

CLI Help Text

src/cli.rs

/// Clear description of what this option does
#[arg(long, short = 'x')]
pub new_option: bool,

--help