@venizia/ignis-docs 0.0.3 → 0.0.4-0

package/wiki/references/src-details/index.md

@@ -0,0 +1,86 @@
+# Framework Internals
+
+Deep dive into Ignis package structure and source code organization.
+
+## Quick Reference
+
+| Package | npm | Purpose |
+|---------|-----|---------|
+| `@venizia/ignis` | Core | Main framework with controllers, repositories, components |
+| `@venizia/ignis-boot` | Boot | Auto-discovery and bootstrapping utilities |
+| `@venizia/ignis-helpers` | Helpers | Reusable utilities (logger, crypto, redis, etc.) |
+| `@venizia/ignis-inversion` | Inversion | Standalone dependency injection container |
+| `@venizia/dev-configs` | Dev Configs | TypeScript, ESLint, Prettier configurations |
+| `@venizia/ignis-docs` | Docs | Documentation site and MCP server |
+
+## Monorepo Structure
+
+```
+ignis/
+├── packages/
+│   ├── core/           → @venizia/ignis (main framework)
+│   ├── boot/           → @venizia/ignis-boot (auto-discovery)
+│   ├── helpers/        → @venizia/ignis-helpers (utilities)
+│   ├── inversion/      → @venizia/ignis-inversion (DI container)
+│   ├── dev-configs/    → @venizia/dev-configs (linting/formatting)
+│   └── docs/           → @venizia/ignis-docs (documentation)
+├── examples/           → Example applications
+└── scripts/            → Build and maintenance scripts
+```
+
+## Package Dependencies
+
+```
+┌─────────────────────────────────────────────────────────┐
+│                    @venizia/ignis                        │
+│                   (Core Framework)                       │
+│                                                         │
+│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐  │
+│  │ base/        │  │ components/  │  │ utilities/   │  │
+│  │ (Controllers,│  │ (Auth, Swagger,│ │ (Crypto,     │  │
+│  │  Repos, etc.)│  │  HealthCheck) │ │  Date, etc.) │  │
+│  └──────────────┘  └──────────────┘  └──────────────┘  │
+└────────────────────────┬────────────────────────────────┘
+                         │ depends on
+         ┌───────────────┼───────────────┐
+         ▼               ▼               ▼
+┌────────────────┐ ┌────────────┐ ┌────────────────┐
+│ @vez/ignis-boot│ │@vez/ignis- │ │ @vez/ignis-    │
+│ (Auto-Discovery)│ │  helpers   │ │  inversion     │
+│                │ │ (Logger,   │ │ (DI Container) │
+│                │ │  Redis,etc)│ │                │
+└────────────────┘ └─────┬──────┘ └────────────────┘
+                         │ depends on
+                         ▼
+               ┌─────────────────────┐
+               │ @vez/ignis-inversion│
+               │   (Standalone DI)   │
+               └─────────────────────┘
+```
+
+## What's in This Section
+
+### Core Package
+- [Core (@venizia/ignis)](./core.md) - Main framework with base classes, components, and utilities
+
+### Supporting Packages
+- [Boot (@venizia/ignis-boot)](./boot.md) - Automatic artifact discovery and registration
+- [Helpers (@venizia/ignis-helpers)](./helpers.md) - Reusable helper classes (logger, crypto, redis, etc.)
+- [Inversion (@venizia/ignis-inversion)](./inversion.md) - Standalone dependency injection container
+
+### Development Tools
+- [Dev Configs (@venizia/dev-configs)](./dev-configs.md) - Shared TypeScript, ESLint, Prettier configs
+- [Documentation (@venizia/ignis-docs)](./docs.md) - VitePress site and wiki structure
+- [MCP Docs Server](./mcp-server.md) - Model Context Protocol server for AI-assisted development
+
+## Package Purposes
+
+| Package | When to Use |
+|---------|-------------|
+| **@venizia/ignis** | Building Ignis applications (always needed) |
+| **@venizia/ignis-boot** | Auto-discovery of controllers, services, repositories |
+| **@venizia/ignis-helpers** | Standalone utilities without full framework |
+| **@venizia/ignis-inversion** | DI container without framework dependencies |
+| **@venizia/dev-configs** | Consistent dev tooling across projects |
+
+> **Related:** [Core Concepts Guide](../../guides/core-concepts/application/) | [Base Abstractions Reference](../base/)

package/wiki/references/src-details/inversion.md

@@ -176,7 +176,6 @@ const key = BindingKeys.build({ namespace: 'services', key: 'UserService' });
 | `IPropertyMetadata` | Property injection metadata |
 | `IInjectMetadata` | Constructor injection metadata |
 
----
 
 ## Injection Metadata
 
@@ -200,7 +199,6 @@ interface IInjectMetadata {
 }
 ```
 
----
 
 ## Project Structure
 
@@ -226,7 +224,6 @@ packages/inversion/
 └── dist/                     # Built output
 ```
 
----
 
 ## Usage Examples
 
@@ -307,7 +304,6 @@ if (cache) {
 }
 ```
 
----
 
 ## Integration with Framework
 
@@ -327,7 +323,6 @@ import { Container, Binding } from '@venizia/ignis-inversion';
 import { Container, inject, service } from '@venizia/ignis';
 ```
 
----
 
 ## Building the Package
 
@@ -342,4 +337,4 @@ bun run clean
 
 # Rebuild (clean + build)
 bun run rebuild
-```
+```

package/wiki/references/src-details/mcp-server.md

@@ -1,6 +1,6 @@
 # MCP Docs Server: Deep Dive
 
-This document provides a detailed look into the architecture, features, and internal workings of the Ignis Documentation MCP Server. For a guide on how to use the server, see the [MCP Docs Server Quickstart](/get-started/mcp-docs-server).
+This document provides a detailed look into the architecture, features, and internal workings of the Ignis Documentation MCP Server. For a guide on how to use the server, see the [MCP Docs Server Quickstart](/guides/reference/mcp-docs-server).
 
 ---
 
@@ -109,7 +109,6 @@ sequenceDiagram
     MCP-->>AI: JSON results
 ```
 
----
 
 ## Tools Reference
 
@@ -156,7 +155,6 @@ Retrieves high-level information about specific framework packages.
 - **Input:** `{ packageName?: string }`
 - **Returns:** Package description, version, and purpose.
 
----
 
 ### 2. Code & Project Tools
 
@@ -189,7 +187,6 @@ Checks the `package.json` of a specific package or the root project.
 - **Input:** `{ package?: string }`
 - **Returns:** List of dependencies and their versions.
 
----
 
 ## Resources
 
@@ -205,14 +202,13 @@ The server exposes documentation as MCP resources for direct access:
 
 ```json
 {
-  "uri": "ignis://docs/get-started/intro.md",
+  "uri": "ignis://docs/guides/intro.md",
   "name": "Introduction",
   "description": "Getting Started - 450 words",
   "mimeType": "text/markdown"
 }
 ```
 
----
 
 ## Search Configuration
 
@@ -243,7 +239,6 @@ pie
 
 **Why this matters:** When you search for "dependency injection", documents with that phrase in the title will rank higher than those with it only in the content.
 
----
 
 ## Project Structure
 
@@ -292,7 +287,6 @@ mcp-server/
 | `common/logger.ts` | Structured logging | `Logger` class |
 | `common/paths.ts` | Path resolution | `Paths` object |
 
----
 
 ## Performance Characteristics
 
@@ -330,7 +324,6 @@ graph LR
 - Memory usage is constant after first load
 - No disk I/O after initialization
 
----
 
 ## Error Handling
 
@@ -369,7 +362,6 @@ All tools return consistent error responses:
 DEBUG=1 ignis-docs-mcp
 ```
 
----
 
 ## Development Guide
 
@@ -526,7 +518,6 @@ export class MCPConfigs {
 | `title weight` | Less title importance | More title importance |
 | `snippetLength` | Shorter previews | Longer previews |
 
----
 
 ## Best Practices
 
@@ -540,7 +531,7 @@ export class MCPConfigs {
 
 ### For Developers
 
-1. **Document IDs**: Always use relative paths from wiki root (e.g., "get-started/intro.md")
+1. **Document IDs**: Always use relative paths from wiki root (e.g., "guides/intro.md")
 2. **Frontmatter**: Ensure all markdown files have `title` and `category` in frontmatter
 3. **Search Queries**: Use descriptive queries for better results (minimum 2 characters)
 4. **Result Limits**: Adjust limit parameter based on needs (default: 10, max: 50)
@@ -574,7 +565,6 @@ export class MCPConfigs {
 3. getDocContent("references/api.md") → Fetch full content
 ```
 
----
 
 ## Debugging
 
@@ -608,7 +598,6 @@ DEBUG=docs:cache ignis-docs-mcp
 | Check search | Use searchDocs tool | "Found N matches in Xms" |
 | Inspect cache | Check memory usage | ~5-10MB after first load |
 
----
 
 ## Roadmap
 
@@ -628,7 +617,6 @@ Want to add features or fix bugs? See the main Ignis repository:
 - **Issues**: Report bugs or request features
 - **Pull Requests**: Submit improvements
 
----
 
 ## FAQ
 

package/wiki/references/utilities/index.md

@@ -1,12 +1,88 @@
 # Utilities
 
-Utilities are pure, standalone functions that provide common, reusable logic for various tasks within the Ignis framework. They are designed to be simple, stateless, and easy to use.
-
--   [Crypto](./crypto.md): Simple, stateless cryptographic functions.
--   [Date](./date.md): Provides date and time manipulation functions, built on `dayjs`.
--   [Module](./module.md): A utility for checking if a Node.js module is installed.
--   [Parse](./parse.md): A collection of functions for parsing and converting data types.
--   [Performance](./performance.md): Utilities for measuring code execution time.
--   [Promise](./promise.md): Helper functions for working with Promises.
--   [Request](./request.md): Utilities for handling HTTP requests, such as parsing multipart form data and creating secure Content-Disposition headers.
--   [Schema](./schema.md): Helpers for creating and validating Zod schemas, especially for request and response validation in an OpenAPI context.
+Pure, standalone functions providing common, reusable logic for the Ignis framework. All utilities are stateless and easy to use.
+
+## Quick Reference
+
+| Utility | Purpose | Key Functions |
+|---------|---------|---------------|
+| **Crypto** | Cryptographic operations | `hash()`, `compare()`, `encrypt()`, `decrypt()` |
+| **Date** | Date/time manipulation | `format()`, `parse()`, `diff()`, `add()` |
+| **JSX** | HTML/JSX responses | `htmlContent()`, `htmlResponse()` |
+| **Module** | Module detection | `isInstalled()`, `resolve()` |
+| **Parse** | Data type conversion | `toBoolean()`, `toNumber()`, `toArray()` |
+| **Performance** | Execution timing | `measure()`, `measureAsync()` |
+| **Promise** | Promise helpers | `delay()`, `timeout()`, `retry()` |
+| **Request** | HTTP utilities | `parseMultipart()`, `contentDisposition()` |
+| **Schema** | Zod schema helpers | `jsonContent()`, `jsonResponse()` |
+| **Statuses** | Status code constants | `Statuses`, `UserStatuses`, `CommonStatuses` |
+
+## What's in This Section
+
+### Data Processing
+
+- [**Crypto**](./crypto.md) - Simple, stateless cryptographic functions for hashing, comparison, and encryption/decryption operations
+- [**Parse**](./parse.md) - Functions for parsing and converting data types safely with proper type inference
+- [**Schema**](./schema.md) - Helpers for creating and validating Zod schemas, especially for OpenAPI request/response validation
+- [**Statuses**](./statuses.md) - Standardized status code constants for entity lifecycle management
+
+### Time & Performance
+
+- [**Date**](./date.md) - Date and time manipulation functions built on `dayjs` with timezone support
+- [**Performance**](./performance.md) - Utilities for measuring code execution time and performance profiling
+
+### Async & HTTP
+
+- [**JSX**](./jsx.md) - HTML and JSX response utilities for server-side rendering and OpenAPI documentation
+- [**Promise**](./promise.md) - Helper functions for working with Promises including retry, timeout, and delay
+- [**Request**](./request.md) - HTTP request utilities for parsing multipart form data and creating secure Content-Disposition headers
+
+### Runtime
+
+- [**Module**](./module.md) - Utility for checking if a Node.js module is installed at runtime
+
+## Usage Pattern
+
+All utilities are imported from `@venizia/ignis`:
+
+```typescript
+import {
+  hash,
+  compare,
+  formatDate,
+  toBoolean,
+  jsonContent,
+  jsonResponse,
+  htmlResponse,
+  Statuses,
+} from '@venizia/ignis';
+
+// Crypto
+const hashed = await hash({ value: 'password123' });
+const isMatch = await compare({ value: 'password123', hashed });
+
+// Date
+const formatted = formatDate({ date: new Date(), format: 'YYYY-MM-DD' });
+
+// Parse
+const boolValue = toBoolean('true'); // true
+
+// Schema (for OpenAPI JSON routes)
+const responseSchema = jsonResponse({
+  description: 'User data',
+  schema: z.object({ id: z.string(), name: z.string() }),
+});
+
+// JSX (for HTML routes)
+const htmlResponseSchema = htmlResponse({
+  description: 'Dashboard page',
+});
+
+// Statuses
+const order = { status: Statuses.COMPLETED };
+if (Statuses.isCompleted(order.status)) {
+  console.log('Order is complete');
+}
+```
+
+> **Related:** [Helpers Reference](../helpers/) | [Core Concepts Guide](../../guides/core-concepts/application/)