📦 deps(thirdparty): update snapshots

2026-05-29 08:33:53 +00:00
parent fdb52f1e96
commit 06e0d13d57
1615 changed files with 232858 additions and 0 deletions
@@ -0,0 +1,192 @@
+# Documentation Completeness Checklist
+
+Use this checklist when auditing documentation for coverage and required content.
+
+## Export Coverage
+
+### TypeScript/JavaScript
+
+Every public export should have documentation:
+
+```typescript
+// ✅ Documented export
+/**
+ * Processes user input and returns validated result.
+ * @param input - Raw user input string
+ * @returns Validated and sanitized input
+ * @throws {ValidationError} If input fails validation
+ */
+export function processInput(input: string): ValidatedInput { ... }
+
+// ❌ Undocumented export
+export function processInput(input: string): ValidatedInput { ... }
+```
+
+**Check coverage:**
+```bash
+# Count exports
+EXPORTS=$(grep -c "^export " src/**/*.ts)
+# Count documented exports (/** before export)
+DOCUMENTED=$(grep -B1 "^export " src/**/*.ts | grep -c "/\*\*")
+# Coverage = DOCUMENTED / EXPORTS * 100
+```
+
+### Python
+
+Every public function/class should have a docstring:
+
+```python
+# ✅ Documented
+def process_input(input: str) -> ValidatedInput:
+    """Process user input and return validated result.
+
+    Args:
+        input: Raw user input string
+
+    Returns:
+        Validated and sanitized input
+
+    Raises:
+        ValidationError: If input fails validation
+    """
+    ...
+
+# ❌ Undocumented
+def process_input(input: str) -> ValidatedInput:
+    ...
+```
+
+### Rust
+
+Every public item should have doc comments:
+
+```rust
+// ✅ Documented
+/// Processes user input and returns validated result.
+///
+/// # Arguments
+/// * `input` - Raw user input string
+///
+/// # Returns
+/// Validated and sanitized input
+///
+/// # Errors
+/// Returns `ValidationError` if input fails validation
+pub fn process_input(input: &str) -> Result<ValidatedInput, ValidationError> { ... }
+
+// ❌ Undocumented
+pub fn process_input(input: &str) -> Result<ValidatedInput, ValidationError> { ... }
+```
+
+### Go
+
+Every exported function should have a godoc comment:
+
+```go
+// ✅ Documented
+// ProcessInput processes user input and returns validated result.
+// It returns a ValidationError if input fails validation.
+func ProcessInput(input string) (ValidatedInput, error) { ... }
+
+// ❌ Undocumented
+func ProcessInput(input string) (ValidatedInput, error) { ... }
+```
+
+## Required Sections by Document Type
+
+### README.md
+
+- [ ] **Title** - Clear project name
+- [ ] **Description** - What it does (1-2 sentences)
+- [ ] **Installation** - How to install/setup
+- [ ] **Quick Start** - Minimal working example
+- [ ] **Usage** - Basic usage patterns
+- [ ] **License** - License type or link
+
+**Nice to have:**
+- [ ] Badges (build status, version, etc.)
+- [ ] Table of contents (for long READMEs)
+- [ ] Contributing guidelines or link
+- [ ] Changelog or link
+
+### API Reference
+
+- [ ] **Overview** - What the API does
+- [ ] **Authentication** - How to authenticate
+- [ ] **Base URL** - API endpoint base
+- [ ] **Endpoints** - All public endpoints documented
+- [ ] **Request/Response** - Schemas for each endpoint
+- [ ] **Errors** - Common error codes and meanings
+
+### Configuration Reference
+
+- [ ] **Overview** - What can be configured
+- [ ] **File Location** - Where config lives
+- [ ] **Format** - JSON, YAML, TOML, etc.
+- [ ] **All Options** - Each config key documented
+- [ ] **Defaults** - Default values listed
+- [ ] **Examples** - Working config examples
+
+### CLI Reference
+
+- [ ] **Installation** - How to install
+- [ ] **Commands** - All commands documented
+- [ ] **Options** - Global and command-specific options
+- [ ] **Examples** - Common usage examples
+- [ ] **Exit Codes** - What different exit codes mean
+
+### Contributing Guide
+
+- [ ] **Setup** - Development environment setup
+- [ ] **Workflow** - How to submit changes
+- [ ] **Standards** - Code style, testing requirements
+- [ ] **Review Process** - What to expect
+
+### Changelog
+
+- [ ] **Version Numbers** - Semantic versioning
+- [ ] **Dates** - Release dates
+- [ ] **Categories** - Added, Changed, Fixed, Removed
+- [ ] **Migration Notes** - For breaking changes
+
+## Cross-Reference Completeness
+
+### Internal Links
+- [ ] All mentioned features link to their docs
+- [ ] Related concepts are cross-linked
+- [ ] No dead internal links
+
+### External Links
+- [ ] Dependencies link to their docs
+- [ ] Standards link to specifications
+- [ ] Tools link to official sites
+
+## Example Completeness
+
+### Code Examples Should Include
+- [ ] Necessary imports
+- [ ] Variable declarations with types
+- [ ] Error handling (where appropriate)
+- [ ] Expected output (for non-obvious cases)
+
+### Example Types Needed
+- [ ] **Minimal** - Simplest possible usage
+- [ ] **Typical** - Common real-world usage
+- [ ] **Advanced** - Complex scenarios (if applicable)
+- [ ] **Edge Cases** - Unusual but valid inputs
+
+## Accessibility
+
+- [ ] **Alt text** - Images have descriptive alt text
+- [ ] **Headings** - Proper heading hierarchy (h1 > h2 > h3)
+- [ ] **Code blocks** - Language specified for syntax highlighting
+- [ ] **Tables** - Headers on tables
+
+## Severity Classification
+
+| Severity | Criteria | Example |
+|----------|----------|---------|
+| **Critical** | Core functionality undocumented | No installation instructions, main API undocumented |
+| **High** | Important features undocumented | Missing error handling docs, no config reference |
+| **Medium** | Nice-to-have sections missing | No contributing guide, missing advanced examples |
+| **Low** | Polish items | Missing badges, no table of contents |
@@ -0,0 +1,131 @@
+# Documentation Correctness Checklist
+
+Use this checklist when auditing documentation for accuracy against the current codebase.
+
+## Code Examples
+
+### Import Statements
+- [ ] Import paths resolve to existing files
+- [ ] Named imports match actual exports
+- [ ] Package names match `package.json` / `Cargo.toml` / `pyproject.toml`
+- [ ] Relative vs absolute imports are correct for the context
+
+**How to verify:**
+```bash
+# Extract import from doc, check if file exists
+grep -E "^import|^from|^require" {doc_file} | head -5
+# Then verify each path exists
+```
+
+### Function Signatures
+- [ ] Function names exist in codebase
+- [ ] Parameter names match implementation
+- [ ] Parameter types are accurate
+- [ ] Return types are accurate
+- [ ] Optional parameters marked correctly
+
+**How to verify:**
+```bash
+# Find function definition in code
+grep -rn "function {name}\|{name} = \|def {name}\|fn {name}" --include="*.ts" --include="*.py" --include="*.rs"
+```
+
+### Configuration Examples
+- [ ] Config keys exist in schema/types
+- [ ] Default values match implementation
+- [ ] Required vs optional fields accurate
+- [ ] Value types (string, number, boolean) correct
+
+**How to verify:**
+```bash
+# Find config type/interface
+grep -rn "interface.*Config\|type.*Config\|Config = " --include="*.ts"
+```
+
+## CLI Documentation
+
+### Commands
+- [ ] Command names are correct
+- [ ] Subcommands exist
+- [ ] Command descriptions accurate
+
+### Flags/Options
+- [ ] Flag names (short and long) correct
+- [ ] Flag descriptions accurate
+- [ ] Default values documented correctly
+- [ ] Required flags marked as such
+
+**How to verify:**
+```bash
+# Run help command
+{cli} --help
+{cli} {subcommand} --help
+```
+
+## API Documentation
+
+### Endpoints
+- [ ] HTTP methods correct (GET, POST, etc.)
+- [ ] URL paths accurate
+- [ ] Query parameters documented
+- [ ] Request body schema matches implementation
+- [ ] Response schema matches implementation
+- [ ] Status codes documented
+
+**How to verify:**
+```bash
+# Find route definitions
+grep -rn "app.get\|app.post\|router\." --include="*.ts" --include="*.js"
+# Or for OpenAPI
+cat openapi.yaml | grep "paths:" -A 100
+```
+
+### Authentication
+- [ ] Auth methods accurate (Bearer, API key, etc.)
+- [ ] Required headers documented
+- [ ] Error responses for auth failures documented
+
+## Environment Variables
+
+- [ ] Variable names match actual usage
+- [ ] Descriptions accurate
+- [ ] Required vs optional clearly marked
+- [ ] Example values are realistic (not revealing secrets)
+
+**How to verify:**
+```bash
+# Find env var usage
+grep -rn "process.env\|os.environ\|env::" --include="*.ts" --include="*.py" --include="*.rs"
+# Or check .env.example
+cat .env.example
+```
+
+## Error Messages
+
+- [ ] Documented errors actually thrown by code
+- [ ] Error codes/types match implementation
+- [ ] Troubleshooting steps are accurate
+
+**How to verify:**
+```bash
+# Find error definitions
+grep -rn "throw new\|raise \|Error::" --include="*.ts" --include="*.py" --include="*.rs"
+```
+
+## Version-Specific Features
+
+- [ ] Features available in documented version
+- [ ] Deprecated features marked
+- [ ] Breaking changes noted with versions
+- [ ] Minimum version requirements accurate
+
+## Severity Classification
+
+When an issue is found, classify it:
+
+| Severity | Criteria | Example |
+|----------|----------|---------|
+| **Critical** | Will cause errors if user follows docs | Wrong import path, non-existent function |
+| **High** | Will cause confusion or unexpected behavior | Wrong default value, missing required param |
+| **Medium** | Incomplete but not wrong | Missing optional parameters, outdated example |
+| **Low** | Cosmetic or minor | Typo in description, suboptimal example |