Documentation Contributions

# Feature Name
 
One sentence explaining what this does.
 
## Overview
 
Brief explanation (2-3 sentences).
 
## Prerequisites
 
- What users need before starting
- Required dependencies
- Minimum versions
 
## Quick Start
 
Fastest way to get working.
 
## Detailed Usage
 
### Option 1: Common Case
Step-by-step with examples.
 
### Option 2: Advanced Case
For power users.
 
## Configuration
 
| Option | Default | Description |
|--------|---------|-------------|
| `timeout` | `30s` | Request timeout |
 
## Troubleshooting
 
### Common Issue 1
Cause and solution.
 
### Common Issue 2
Cause and solution.
 
## Related
 
- Links to related docs

# Auth
 
Use the auth function to authenticate.
 
    auth(credentials)
 
This will authenticate the user.

# Authentication
 
Authenticate users with the `auth()` function.
 
## Quick Start
 
```javascript
import { auth } from 'library';
 
const session = await auth({
    email: 'user@example.com',
    password: 'secure-password'
});
 
console.log(session.token); // JWT token

{
    token: 'eyJhbG...',     // JWT authentication token
    userId: '123',           // User's unique ID
    expiresAt: 1234567890   // Token expiration timestamp
}

import { auth, AuthError } from 'library';
 
async function login(email, password) {
    try {
        const session = await auth({ email, password });
        localStorage.setItem('token', session.token);
        return session;
    } catch (error) {
        if (error instanceof AuthError) {
            console.error('Login failed:', error.message);
        }
        throw error;
    }
}

### Key Principles

| Principle | Description |
|-----------|-------------|
| **Concise** | No unnecessary words |
| **Complete** | All needed information |
| **Correct** | Accurate and tested |
| **Current** | Up to date |
| **Consistent** | Same style throughout |

## Writing Code Examples

### Good Examples

```javascript
// ✅ Shows real use case
const user = await getUser('user-123');
console.log(`Welcome, ${user.name}!`);

// ❌ Too abstract
const x = await fn(a);
console.log(x);

# Heading 1
## Heading 2
### Heading 3
 
**bold** and *italic*
 
- Bullet point
- Another point
 
1. Numbered
2. List
 
`inline code`
 
    code block (4 spaces)
 
```language
fenced code block

### Project-Specific Formats

| Format | Tools |
|--------|-------|
| Markdown | GitHub, GitLab, most projects |
| MDX | React projects, Docusaurus |
| reStructuredText | Python (Sphinx) |
| AsciiDoc | Some enterprise projects |
| YAML/JSON | API documentation |

## Types of Doc Contributions

### 1. Fixing Typos

Smallest but valuable!

```diff
- This function retuns a value
+ This function returns a value

- Use the function to do stuff
+ Call `processData()` to validate and transform user input

  ## Usage
  
  Call the function with your data.
  
+ ### Example
+ 
+ ```javascript
+ const result = processData({ name: 'John', age: 30 });
+ console.log(result); // { valid: true, processed: {...} }
+ ```

  ## Installation
  
  npm install library
  
+ ## Configuration
+ 
+ Create a config file in your project root:
+ 
+ ```javascript
+ // library.config.js
+ module.exports = {
+   option1: true,
+   option2: 'value'
+ };
+ ```

- ## Requires Node.js 14+
+ ## Requires Node.js 18+

docs/
  en/
    getting-started.md
  es/           # Spanish
    getting-started.md
  zh/           # Chinese
    getting-started.md

## Description
 
[What docs are you changing and why]
 
## Type of Change
 
- [ ] Fix typo/grammar
- [ ] Improve clarity
- [ ] Add missing content
- [ ] Update outdated content
- [ ] Add examples
- [ ] Other: [describe]
 
## Checklist
 
- [ ] I've read the contributing guide
- [ ] I've previewed my changes
- [ ] Links are working
- [ ] Code examples are correct

# npm
npm install -g cspell
cspell "docs/**/*.md"
 
# VSCode extension: Code Spell Checker

# Check for broken links
npm install -g markdown-link-check
find docs -name "*.md" -exec markdown-link-check {} \;

# For markdown
npm install -g markdown-preview
 
# For Docusaurus
npm run start
 
# For MkDocs
mkdocs serve

## Open Source Contributions
 
**Documentation Lead** - [Project Name]
- Rewrote getting started guide, reducing setup issues by 40%
- Added 15 code examples to API documentation
- Translated documentation to Spanish (3,000+ words)

docs: fix typo in README
docs: add installation example for Windows
docs(api): add authentication examples
docs: update Node.js version requirement
docs(contributing): clarify PR process

# GitHub search
repo:org/repo is:issue is:open label:documentation
repo:org/repo is:issue is:open label:good-first-issue label:docs