documentation-system

Documentation System

Overview

The Shipkit documentation system uses dynamic file-based loading from the /docs directory at the project root. It supports both .mdx and .md files with full production-ready security features.

Architecture

Core Components

• Main Library: src/lib/docs.ts - Core documentation loading and processing
• Search Service: src/server/services/docs-search.ts - Documentation search functionality
• Pages: src/app/(app)/docs/[[...slug]]/page.tsx - Dynamic routing for docs

File Structure

/docs/                          # Root documentation directory
├── index.mdx                   # Main documentation index
├── *.mdx, *.md                # Root level docs
├── content-management/         # Organized by topic
│   ├── index.mdx              # Section index
│   └── *.mdx, *.md            # Section documentation
├── development/
├── integrations/
└── snippets/

Security Features (Production-Ready)

Input Validation & Sanitization

• Path Traversal Protection: All file paths validated using path.resolve()
• Slug Validation: Regex patterns prevent malicious input
• Content Sanitization: HTML sanitization prevents XSS attacks
• Size Limits: Files limited to 5MB, content to 1MB

Rate Limiting & DoS Prevention

• Maximum 100 documents total
• Maximum 20 directories per level
• Maximum 50 files per directory
• Maximum depth of 5 levels
• Input length limits enforced via Zod schemas

Error Handling

• Comprehensive error logging without information leakage
• Graceful degradation on missing files
• Proper HTTP status codes
• No stack trace exposure in production

File Format Support

MDX Files (.mdx)

• Full React component support
• Frontmatter metadata required
• Dynamic imports supported
• Processing via remark/rehype

Markdown Files (.md)

• Standard markdown syntax
• Frontmatter metadata required
• Converted to React components
• Syntax highlighting support