Invalid Doc

Fix Invalid Documentation Guide

Follow this guide to fix incorrect or invalid documentation following Marty conventions.

When to Fix Docs

• Documentation contradicts actual behavior
• Instructions don't work as described
• Configuration values are wrong
• Deprecated content not marked
• Wrong paths or filenames
• Incorrect code examples

Fix Process

Step 1: Identify the Problem

# Verify actual behavior
# Compare doc to reality

# Check if file paths exist
ls actual/path.md

# Verify configuration values
cat config.json | jq .

Step 2: Research Correct Information

• Test the actual behavior
• Check source code for correct values
• Verify paths match actual structure
• Consult relevant team members if needed

Step 3: Fix the Documentation

# Correct the documentation with accurate information
# Include note explaining the fix if relevant

Common Fixes

Wrong Path

# Before (Wrong)
See the configuration guide at `/docs/config.md`

# After (Correct)
See the configuration guide at `docs/guides/config.md`

Outdated Command

# Before (Outdated)
Run `npm run server` to start the server.

# After (Correct)
Run `npm run dev` to start the development server.

Incorrect Configuration

# Before (Wrong)
Set `timeout: 30` to configure the timeout.

# After (Correct)
Set `timeout: 30000` (in milliseconds) to configure the timeout.

Documentation Health Check

• Commands work as documented
• Paths are correct
• Configuration values are accurate
• Version numbers are current
• Deprecated warnings are present

Quick Reference

Verify path:           ls docs/path.md
Test command:          npm run command
Check config:          cat config.json | jq .
Fix with accurate info: Edit with correct information

Related Skills