NitroStack Documentation Structure

This directory contains the source-of-truth markdown documentation for NitroStack.

Structure

docs/
├── README.md                    # This file
├── cli/                         # CLI Documentation (Universal)
│   ├── 01-introduction.md
│   ├── 02-installation.md
│   ├── 03-init-command.md
│   ├── 04-dev-command.md
│   ├── 05-build-command.md
│   └── 06-configuration.md
│
├── sdk/                         # SDK Documentation (Language-specific)
│   └── typescript/
│       ├── 01-quick-start.md
│       ├── 02-core-concepts/
│       │   ├── server.md
│       │   ├── tools.md
│       │   ├── resources.md
│       │   ├── prompts.md
│       │   └── middleware.md
│       ├── 03-ui-components/
│       │   ├── overview.md
│       │   ├── creating-widgets.md
│       │   ├── nextjs-integration.md
│       │   ├── data-binding.md
│       │   └── hot-reload.md
│       ├── 04-authentication/
│       │   ├── overview.md
│       │   ├── oauth-2.1.md
│       │   ├── jwt-auth.md
│       │   ├── api-key-auth.md
│       │   └── security-best-practices.md
│       ├── 05-advanced/
│       │   ├── middleware-system.md
│       │   ├── lifecycle-hooks.md
│       │   ├── error-handling.md
│       │   ├── logging.md
│       │   └── testing.md
│       ├── 06-inspector/
│       │   ├── overview.md
│       │   ├── testing-tools.md
│       │   ├── chat-interface.md
│       │   └── debugging.md
│       └── 07-api-reference/
│           ├── server-api.md
│           ├── tool-api.md
│           ├── resource-api.md
│           ├── prompt-api.md
│           ├── component-api.md
│           └── types.md
│
├── templates/                   # Template Documentation
│   ├── typescript-basic.md
│   └── typescript-auth.md
│
├── deployment/                  # Deployment Guides
│   ├── production-checklist.md
│   ├── docker.md
│   ├── cloud-platforms.md
│   └── monitoring.md
│
└── guides/                      # How-to Guides
    ├── building-first-server.md
    ├── adding-authentication.md
    ├── creating-ui-widgets.md
    ├── integrating-databases.md
    └── best-practices.md

Documentation Guidelines

1. Code Examples: Every major concept should have a complete, runnable code example
2. API Reference: Include full parameter lists, return types, and examples
3. Best Practices: Highlight common pitfalls and recommended patterns
4. Cross-links: Link between related concepts for easy navigation
5. Version Tags: Mark features that require specific versions

Contributing

When adding new documentation:

1. Update this README with the new file location
2. Follow the existing markdown style
3. Include code examples
4. Add cross-references to related docs