Welcome to Documentation

Generated: 2026-01-12 UTC
Status: Placeholder - Ready for customization
Verified: (Auto-generated content)

Overview

This documentation site was built with @knowcode/doc-builder. This is an auto-generated placeholder to help you get started.

Getting Started

Replace this file: Edit docs/README.md with your project's actual documentation
Add content: Create additional markdown files in the docs/ directory
Organize with folders: Use subfolders to structure your documentation
Rebuild: Run npx @knowcode/doc-builder@latest build to regenerate the site

Documentation Structure

Your documentation can include:

Overview: Main project description (this file)
Guides: Step-by-step tutorials
API Reference: Technical documentation
Examples: Code samples and usage
Architecture: System design and technical details

Next Steps

Edit this README.md file with your project information
Create additional markdown files for your content
Organize files into logical folders
Use Mermaid diagrams for visual explanations
Deploy with npx @knowcode/doc-builder@latest deploy

Documentation Standards

This project follows structured documentation conventions:

File Organization

Use descriptive filenames with hyphens (e.g., user-guide.md)
Organize related content in folders
Include a README.md in each major folder

Content Format

Start each document with metadata (Generated date, Status, Verified status)
Use clear headings and consistent structure
Include diagrams where helpful to explain concepts
Mark information as verified () or speculated ()

Mermaid Diagrams

Include visual diagrams to explain complex concepts:

graph TD A[Start Documentation] --> B{Have Content?} B -->|Yes| C[Edit README.md] B -->|No| D[Create Content Files] C --> E[Build & Deploy] D --> E E --> F[Share Documentation]

Support

For help with @knowcode/doc-builder:

Check the documentation at your package source
Use npx @knowcode/doc-builder@latest --help for CLI options
Review the generated configuration guide if available