@venizia/ignis-docs 0.0.1-1

package/mcp-server/dist/tools/list-docs.tool.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListDocsTool = void 0;
+const zod_1 = require("zod");
+const helpers_1 = require("../helpers");
+const base_tool_1 = require("./base.tool");
+// ----------------------------------------------------------------------------
+// DESCRIPTIONS
+// ----------------------------------------------------------------------------
+const TOOL_DESCRIPTION = `
+Lists all available Ignis Framework documentation files with their identifiers, titles, and categories.
+
+PURPOSE:
+Use this tool to discover what documentation is available. It provides a complete catalog
+of all documents, optionally filtered by category. Essential for understanding the documentation
+structure and finding specific pages.
+
+WHEN TO USE:
+- To explore what documentation exists
+- To find document IDs for use with getDocContent
+- To browse documents within a specific category
+- When searchDocs doesn't find what you're looking for
+- To understand the overall documentation structure
+- To provide users with a list of available resources
+
+WHEN NOT TO USE:
+- When you know what you're looking for (use searchDocs instead)
+- When you need document content (use getDocContent after getting IDs)
+
+CATEGORY FILTERING:
+- Omit 'category' parameter to get ALL documents
+- Provide exact category name to filter (case-sensitive)
+- Use listCategories first to see available category names
+
+COMMON CATEGORIES IN IGNIS DOCS:
+- "Getting Started" - Introductory guides, quickstart, philosophy
+- "Core Concepts" - DI, lifecycle, configuration fundamentals
+- "Best Practices" - Recommended patterns and approaches
+- "References" - API documentation, component details
+- "Helpers" - Utility libraries documentation
+- "Utilities" - Utility function references
+
+WORKFLOW EXAMPLES:
+1. Browse all docs:
+   listDocs() → Review titles → getDocContent(id)
+
+2. Explore a category:
+   listCategories() → Pick category → listDocs(category) → getDocContent(id)
+
+3. Find specific documentation:
+   searchDocs(query) → If not found → listDocs() to browse manually
+`;
+const CATEGORY_DESCRIPTION = `
+Optional category filter to narrow results to a specific documentation section.
+
+BEHAVIOR:
+- If omitted: Returns ALL documentation files across all categories
+- If provided: Returns only documents matching the exact category name
+
+MATCHING:
+- Case-sensitive exact match required
+- Must match the category string exactly as stored in document frontmatter
+
+HOW TO GET VALID CATEGORIES:
+Use the listCategories tool to retrieve all available category names.
+
+EXAMPLES:
+- "Getting Started" - Introductory documentation
+- "Core Concepts" - Fundamental framework concepts
+- "Best Practices" - Recommended patterns
+- "References" - API and component documentation
+
+TIP: If unsure of exact category name, call listCategories first or omit this parameter.
+`;
+// ----------------------------------------------------------------------------
+// SCHEMAS
+// ----------------------------------------------------------------------------
+const DocEntrySchema = zod_1.z.object({
+    id: zod_1.z
+        .string()
+        .describe("Document ID (relative file path). Use with getDocContent or getDocMetadata."),
+    title: zod_1.z.string().describe("Document title from frontmatter or filename."),
+    category: zod_1.z.string().describe("Document category for organizational grouping."),
+});
+const InputSchema = zod_1.z.object({
+    category: zod_1.z.string().optional().describe(CATEGORY_DESCRIPTION),
+});
+const OutputSchema = zod_1.z.object({
+    count: zod_1.z.number().int().describe("Total documents returned. Reflects filter if applied."),
+    docs: zod_1.z.array(DocEntrySchema).describe("Document entries with id, title, and category."),
+});
+// ----------------------------------------------------------------------------
+// TOOL CLASS
+// ----------------------------------------------------------------------------
+class ListDocsTool extends base_tool_1.BaseTool {
+    constructor() {
+        super(...arguments);
+        this.id = "listDocs";
+        this.description = TOOL_DESCRIPTION;
+        this.inputSchema = InputSchema;
+        this.outputSchema = OutputSchema;
+    }
+    async execute(input) {
+        const docs = await helpers_1.DocsHelper.listDocs({ category: input.category });
+        return {
+            count: docs.length,
+            docs,
+        };
+    }
+    getTool() {
+        return (0, base_tool_1.createTool)({
+            id: this.id,
+            description: this.description,
+            inputSchema: InputSchema,
+            outputSchema: OutputSchema,
+            execute: async ({ context }) => this.execute(context),
+        });
+    }
+}
+exports.ListDocsTool = ListDocsTool;
+//# sourceMappingURL=list-docs.tool.js.map

package/mcp-server/dist/tools/list-docs.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-docs.tool.js","sourceRoot":"","sources":["../../tools/list-docs.tool.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,wCAAwC;AACxC,2CAAqE;AAErE,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CxB,CAAC;AAEF,MAAM,oBAAoB,GAAG;;;;;;;;;;;;;;;;;;;;;CAqB5B,CAAC;AAEF,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E,MAAM,cAAc,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9B,EAAE,EAAE,OAAC;SACF,MAAM,EAAE;SACR,QAAQ,CAAC,6EAA6E,CAAC;IAC1F,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IAC1E,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gDAAgD,CAAC;CAChF,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAC/D,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,uDAAuD,CAAC;IACzF,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,gDAAgD,CAAC;CACzF,CAAC,CAAC;AAEH,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E,MAAa,YAAa,SAAQ,oBAAiD;IAAnF;;QACW,OAAE,GAAG,UAAU,CAAC;QAChB,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,gBAAW,GAAG,WAAW,CAAC;QAC1B,iBAAY,GAAG,YAAY,CAAC;IAoBvC,CAAC;IAlBC,KAAK,CAAC,OAAO,CAAC,KAAkC;QAC9C,MAAM,IAAI,GAAG,MAAM,oBAAU,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAErE,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,IAAI;SACL,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,IAAA,sBAAU,EAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,WAAW;YACxB,YAAY,EAAE,YAAY;YAC1B,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,oCAwBC"}

package/mcp-server/dist/tools/search-docs.tool.d.ts

@@ -0,0 +1,32 @@
+import { z } from "zod";
+import { BaseTool, type TMastraTool } from "./base.tool";
+declare const InputSchema: z.ZodObject<{
+    query: z.ZodString;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+declare const OutputSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    category: z.ZodString;
+    snippet: z.ZodString;
+    score: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;
+export declare class SearchDocsTool extends BaseTool<typeof InputSchema, typeof OutputSchema> {
+    readonly id = "searchDocs";
+    readonly description = "\nPerforms intelligent fuzzy search across the entire Ignis Framework documentation corpus.\n\nPURPOSE:\nUse this tool to find documentation pages relevant to a user's question or topic.\nIt searches both document titles (weighted higher) and content body using the Fuse.js fuzzy matching algorithm.\n\nWHEN TO USE:\n- User asks \"how do I...\" or \"what is...\" questions about Ignis\n- You need to find documentation about a specific feature, concept, or API\n- You want to discover related documentation before diving into specifics\n- User mentions keywords that might appear in documentation\n\nSEARCH BEHAVIOR:\n- Fuzzy matching tolerates typos and partial matches\n- Title matches are weighted 70%, content matches 30%\n- Results sorted by relevance score (lower = better match)\n- Returns snippet previews for quick assessment\n\nWORKFLOW RECOMMENDATION:\n1. Start with searchDocs to find relevant pages\n2. Review returned snippets to identify best matches\n3. Use getDocContent with specific IDs to retrieve full content\n4. Use getDocMetadata if you need document statistics\n\nOUTPUT STRUCTURE:\nReturns array of {id, title, category, snippet, score} objects.\nUse the 'id' field with getDocContent to fetch full document content.\n";
+    readonly inputSchema: z.ZodObject<{
+        query: z.ZodString;
+        limit: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>;
+    readonly outputSchema: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        category: z.ZodString;
+        snippet: z.ZodString;
+        score: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    execute(input: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
+    getTool(): TMastraTool;
+}
+export {};
+//# sourceMappingURL=search-docs.tool.d.ts.map

package/mcp-server/dist/tools/search-docs.tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-docs.tool.d.ts","sourceRoot":"","sources":["../../tools/search-docs.tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,QAAQ,EAAc,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAiFrE,QAAA,MAAM,WAAW;;;iBASf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;;;kBAE2D,CAAC;AAM9E,qBAAa,cAAe,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IACnF,QAAQ,CAAC,EAAE,gBAAgB;IAC3B,QAAQ,CAAC,WAAW,kuCAAoB;IACxC,QAAQ,CAAC,WAAW;;;sBAAe;IACnC,QAAQ,CAAC,YAAY;;;;;;uBAAgB;IAE/B,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;IAOxF,OAAO,IAAI,WAAW;CASvB"}

package/mcp-server/dist/tools/search-docs.tool.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchDocsTool = void 0;
+const zod_1 = require("zod");
+const common_1 = require("../common");
+const helpers_1 = require("../helpers");
+const base_tool_1 = require("./base.tool");
+// ----------------------------------------------------------------------------
+// DESCRIPTIONS
+// ----------------------------------------------------------------------------
+const TOOL_DESCRIPTION = `
+Performs intelligent fuzzy search across the entire Ignis Framework documentation corpus.
+
+PURPOSE:
+Use this tool to find documentation pages relevant to a user's question or topic.
+It searches both document titles (weighted higher) and content body using the Fuse.js fuzzy matching algorithm.
+
+WHEN TO USE:
+- User asks "how do I..." or "what is..." questions about Ignis
+- You need to find documentation about a specific feature, concept, or API
+- You want to discover related documentation before diving into specifics
+- User mentions keywords that might appear in documentation
+
+SEARCH BEHAVIOR:
+- Fuzzy matching tolerates typos and partial matches
+- Title matches are weighted 70%, content matches 30%
+- Results sorted by relevance score (lower = better match)
+- Returns snippet previews for quick assessment
+
+WORKFLOW RECOMMENDATION:
+1. Start with searchDocs to find relevant pages
+2. Review returned snippets to identify best matches
+3. Use getDocContent with specific IDs to retrieve full content
+4. Use getDocMetadata if you need document statistics
+
+OUTPUT STRUCTURE:
+Returns array of {id, title, category, snippet, score} objects.
+Use the 'id' field with getDocContent to fetch full document content.
+`;
+const QUERY_DESCRIPTION = `
+Search query string to match against documentation titles and content.
+
+REQUIREMENTS:
+- Minimum ${common_1.MCP_CONFIG.search.minQueryLength} characters required
+- Supports natural language queries (e.g., "dependency injection setup")
+- Supports technical terms (e.g., "HttpServer middleware")
+- Case-insensitive matching
+
+TIPS FOR EFFECTIVE QUERIES:
+- Use specific technical terms for precise results
+- Try alternative phrasings if initial search yields few results
+- Combine concepts for targeted searches (e.g., "redis cache helper")
+`;
+const LIMIT_DESCRIPTION = `
+Maximum number of results to return.
+
+CONSTRAINTS:
+- Minimum: 1
+- Maximum: ${common_1.MCP_CONFIG.search.maxLimit}
+- Default: ${common_1.MCP_CONFIG.search.defaultLimit}
+
+RECOMMENDATIONS:
+- Use default (10) for general queries
+- Increase to 20-30 for broad topic exploration
+- Use lower values (3-5) when you need only top matches
+`;
+// ----------------------------------------------------------------------------
+// SCHEMAS
+// ----------------------------------------------------------------------------
+const SearchResultSchema = zod_1.z.object({
+    id: zod_1.z
+        .string()
+        .describe("Unique document identifier (relative file path). Use with getDocContent to retrieve full document."),
+    title: zod_1.z.string().describe("Human-readable document title from frontmatter or filename."),
+    category: zod_1.z.string().describe('Document category (e.g., "Getting Started", "References").'),
+    snippet: zod_1.z.string().describe("Content preview (max 300 chars) for quick assessment."),
+    score: zod_1.z.number().optional().describe("Relevance score 0-1 (lower = better match)."),
+});
+const InputSchema = zod_1.z.object({
+    query: zod_1.z.string().min(common_1.MCP_CONFIG.search.minQueryLength).describe(QUERY_DESCRIPTION),
+    limit: zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .max(common_1.MCP_CONFIG.search.maxLimit)
+        .default(common_1.MCP_CONFIG.search.defaultLimit)
+        .describe(LIMIT_DESCRIPTION),
+});
+const OutputSchema = zod_1.z
+    .array(SearchResultSchema)
+    .describe("Search results sorted by relevance. Empty array if no matches.");
+// ----------------------------------------------------------------------------
+// TOOL CLASS
+// ----------------------------------------------------------------------------
+class SearchDocsTool extends base_tool_1.BaseTool {
+    constructor() {
+        super(...arguments);
+        this.id = "searchDocs";
+        this.description = TOOL_DESCRIPTION;
+        this.inputSchema = InputSchema;
+        this.outputSchema = OutputSchema;
+    }
+    async execute(input) {
+        return helpers_1.DocsHelper.searchDocs({
+            query: input.query,
+            limit: input.limit,
+        });
+    }
+    getTool() {
+        return (0, base_tool_1.createTool)({
+            id: this.id,
+            description: this.description,
+            inputSchema: InputSchema,
+            outputSchema: OutputSchema,
+            execute: async ({ context }) => this.execute(context),
+        });
+    }
+}
+exports.SearchDocsTool = SearchDocsTool;
+//# sourceMappingURL=search-docs.tool.js.map

package/mcp-server/dist/tools/search-docs.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-docs.tool.js","sourceRoot":"","sources":["../../tools/search-docs.tool.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,sCAAuC;AACvC,wCAAwC;AACxC,2CAAqE;AAErE,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BxB,CAAC;AAEF,MAAM,iBAAiB,GAAG;;;;YAId,mBAAU,CAAC,MAAM,CAAC,cAAc;;;;;;;;;CAS3C,CAAC;AAEF,MAAM,iBAAiB,GAAG;;;;;aAKb,mBAAU,CAAC,MAAM,CAAC,QAAQ;aAC1B,mBAAU,CAAC,MAAM,CAAC,YAAY;;;;;;CAM1C,CAAC;AAEF,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E,MAAM,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC;IAClC,EAAE,EAAE,OAAC;SACF,MAAM,EAAE;SACR,QAAQ,CACP,oGAAoG,CACrG;IACH,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,6DAA6D,CAAC;IACzF,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4DAA4D,CAAC;IAC3F,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uDAAuD,CAAC;IACrF,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;CACrF,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,mBAAU,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACnF,KAAK,EAAE,OAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,mBAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;SAC/B,OAAO,CAAC,mBAAU,CAAC,MAAM,CAAC,YAAY,CAAC;SACvC,QAAQ,CAAC,iBAAiB,CAAC;CAC/B,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,OAAC;KACnB,KAAK,CAAC,kBAAkB,CAAC;KACzB,QAAQ,CAAC,gEAAgE,CAAC,CAAC;AAE9E,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E,MAAa,cAAe,SAAQ,oBAAiD;IAArF;;QACW,OAAE,GAAG,YAAY,CAAC;QAClB,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,gBAAW,GAAG,WAAW,CAAC;QAC1B,iBAAY,GAAG,YAAY,CAAC;IAkBvC,CAAC;IAhBC,KAAK,CAAC,OAAO,CAAC,KAAkC;QAC9C,OAAO,oBAAU,CAAC,UAAU,CAAC;YAC3B,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,OAAO,IAAA,sBAAU,EAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,WAAW;YACxB,YAAY,EAAE,YAAY;YAC1B,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AAtBD,wCAsBC"}

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@venizia/ignis-docs",
+  "version": "0.0.1-1",
+  "description": "Documentation and MCP Server for Ignis Framework",
+  "keywords": [
+    "ignis",
+    "mcp",
+    "model-context-protocol",
+    "documentation",
+    "ai",
+    "framework"
+  ],
+  "main": "./mcp-server/dist/index.js",
+  "types": "./mcp-server/dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./mcp-server/dist/index.d.ts",
+      "default": "./mcp-server/dist/index.js"
+    },
+    "./tools": {
+      "types": "./mcp-server/dist/tools/index.d.ts",
+      "default": "./mcp-server/dist/tools/index.js"
+    },
+    "./helpers": {
+      "types": "./mcp-server/dist/helpers/index.d.ts",
+      "default": "./mcp-server/dist/helpers/index.js"
+    },
+    "./common": {
+      "types": "./mcp-server/dist/common/index.d.ts",
+      "default": "./mcp-server/dist/common/index.js"
+    }
+  },
+  "bin": {
+    "ignis-docs-mcp": "./mcp-server/dist/index.js"
+  },
+  "files": [
+    "mcp-server/dist",
+    "wiki"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "bun": ">=1.3"
+  },
+  "scripts": {
+    "eslint": "eslint --report-unused-disable-directives .",
+    "lint": "bun run eslint && bun run prettier:cli",
+    "lint:fix": "bun run eslint --fix && bun run prettier:fix",
+    "prettier:cli": "prettier \"**/*.{js,ts}\" -l",
+    "prettier:fix": "bun run prettier:cli --write",
+    "docs:dev": "vitepress dev site",
+    "docs:clean": "sh ./scripts/docs-clean.sh",
+    "docs:build": "vitepress build site",
+    "docs:preview": "vitepress preview site",
+    "premcp:build": "bun run mcp:clean",
+    "mcp:build": "tsc -p tsconfig.json",
+    "mcp:clean": "sh ./scripts/mcp-clean.sh",
+    "mcp:start": "bun run mcp-server/index.ts",
+    "mcp:dev": "bun --watch mcp-server/index.ts",
+    "prepublishOnly": "bun run mcp:build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/venizia-ai/ignis.git",
+    "directory": "packages/docs"
+  },
+  "author": {
+    "name": "VENIZIA AI Developer",
+    "email": "developer@venizia.ai",
+    "url": "https://venizia.ai"
+  },
+  "bugs": {
+    "url": "https://github.com/VENIZIA-AI/ignis/issues"
+  },
+  "homepage": "https://github.com/VENIZIA-AI/ignis/wiki",
+  "license": "MIT",
+  "dependencies": {
+    "@mastra/core": "^0.24.6",
+    "@mastra/mcp": "^0.14.4",
+    "dayjs": "^1.11.19",
+    "debug": "^4.4.3",
+    "fast-glob": "^3.3.3",
+    "fuse.js": "^7.1.0",
+    "gray-matter": "^4.0.3",
+    "zod": "^4.1.13"
+  },
+  "devDependencies": {
+    "@braintree/sanitize-url": "^7.1.1",
+    "@types/bun": "^1.3.4",
+    "@types/glob": "^8.1.0",
+    "@venizia/dev-configs": "latest",
+    "eslint": "^9.36.0",
+    "glob": "^10.4.2",
+    "prettier": "^3.6.2",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.4",
+    "vitepress": "^1.6.4",
+    "vitepress-plugin-mermaid": "^2.0.17",
+    "vue": "^3.5.25"
+  }
+}

package/wiki/get-started/5-minute-quickstart.md

@@ -0,0 +1,266 @@
+# 5-Minute Quickstart
+
+Build your first Ignis API endpoint in 5 minutes. No database, no complex setup - just a working "Hello World" API.
+
+> **Prerequisites:** [Bun installed](./prerequisites.md#installation-quick-links) and basic TypeScript knowledge.
+
+## Step 1: Create Project (30 seconds)
+
+```bash
+mkdir my-app && cd my-app
+bun init -y
+bun add hono @hono/zod-openapi @scalar/hono-api-reference @venizia/ignis
+bun add -d typescript @types/bun @venizia/dev-configs
+```
+
+## Step 2: Configure Development Tools (30 seconds)
+
+Create `tsconfig.json`:
+
+```json
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@venizia/dev-configs/tsconfig.common.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}
+```
+
+Create `eslint.config.mjs`:
+
+```javascript
+import { eslintConfigs } from "@venizia/dev-configs";
+
+export default eslintConfigs;
+```
+
+Create `.prettierrc.mjs`:
+
+```javascript
+import { prettierConfigs } from "@venizia/dev-configs";
+
+export default prettierConfigs;
+```
+
+Create `.prettierignore`:
+
+```
+dist
+node_modules
+*.log
+.*-audit.json
+```
+
+## Step 3: Write Your API (2 minutes)
+
+Create `index.ts`:
+
+```typescript
+import { z } from "@hono/zod-openapi";
+import {
+  BaseApplication,
+  BaseController,
+  controller,
+  get,
+  HTTP,
+  IApplicationInfo,
+  jsonContent,
+} from "@venizia/ignis";
+import { Context } from "hono";
+import appInfo from "./../package.json";
+
+// 1. Define a controller
+@controller({ path: "/hello" })
+class HelloController extends BaseController {
+  constructor() {
+    super({ scope: "HelloController", path: "/hello" });
+  }
+
+  // NOTE: This is a function that must be overridden.
+  override binding() {
+    // Bind dependencies here (if needed)
+    // Extra binding routes with functional way, use `bindRoute` or `defineRoute`
+  }
+
+  @get({
+    configs: {
+      path: "/",
+      method: HTTP.Methods.GET,
+      responses: {
+        [HTTP.ResultCodes.RS_2.Ok]: jsonContent({
+          description: "Says hello",
+          schema: z.object({ message: z.string() }),
+        }),
+      },
+    },
+  })
+  sayHello(c: Context) {
+    return c.json({ message: "Hello from Ignis!" }, HTTP.ResultCodes.RS_2.Ok);
+  }
+}
+
+// 2. Create the application
+class App extends BaseApplication {
+  getAppInfo(): IApplicationInfo {
+    return appInfo;
+  }
+
+  staticConfigure() {
+    // Static configuration before dependency injection
+  }
+
+  preConfigure() {
+    this.controller(HelloController);
+  }
+
+  postConfigure() {
+    // Configuration after all bindings are complete
+  }
+
+  setupMiddlewares() {
+    // Custom middleware setup (optional)
+  }
+}
+
+// 3. Start the server
+const app = new App({
+  scope: "App",
+  config: {
+    host: "0.0.0.0",
+    port: 3000,
+    path: { base: "/api", isStrict: false },
+  },
+});
+
+app.start();
+```
+
+Update `package.json` to add build scripts:
+
+```json
+{
+  "name": "5-mins-qs",
+  "version": "1.0.0",
+  "description": "5-minute quickstart example",
+  "private": true,
+  "scripts": {
+    "start": "bun run src/index.ts",
+    "lint": "eslint --report-unused-disable-directives . && prettier \"**/*.{js,ts}\" -l",
+    "lint:fix": "eslint --report-unused-disable-directives . --fix && prettier \"**/*.{js,ts}\" --write",
+    "build": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
+    "clean": "sh ./scripts/clean.sh",
+    "rebuild": "bun run clean && bun run build",
+    "server:dev": "NODE_ENV=development bun run src/index.ts",
+    "server:prod": "NODE_ENV=production bun run dist/index.js"
+  },
+  "dependencies": {
+    "hono": "^4.4.12",
+    "@hono/zod-openapi": "latest",
+    "@scalar/hono-api-reference": "latest",
+    "@venizia/ignis": "latest"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.3",
+    "@types/bun": "latest",
+    "@venizia/dev-configs": "latest",
+    "eslint": "^9.36.0",
+    "prettier": "^3.6.2",
+    "tsc-alias": "^1.8.10",
+    "tsconfig-paths": "^4.2.0"
+  }
+}
+```
+
+Create `scripts/clean.sh`:
+
+```bash
+#!/bin/bash
+
+# Remove build artifacts
+rm -rf dist/
+rm -rf node_modules/.cache/
+
+# Remove log files
+rm -f *.log
+rm -f .*.log
+rm -f .*-audit.json
+
+echo "Cleaned build artifacts and logs"
+```
+
+## Step 4: Run It (30 seconds)
+
+```bash
+bun run index.ts
+```
+
+Visit `http://localhost:3000/api/hello` in your browser!
+
+**Response:**
+
+```json
+{ "message": "Hello from Ignis!" }
+```
+
+## What Just Happened?
+
+1. **`@controller`** - Registered a controller at `/api/hello`
+2. **`@get`** - Created a GET endpoint
+3. **Zod schema** - Auto-validates response and generates OpenAPI docs
+4. **`app.start()`** - Started HTTP server on port 3000
+
+## View API Docs
+
+Open `http://localhost:3000/doc/explorer` to see interactive Swagger UI documentation!
+
+## Next Steps
+
+✅ **You have a working API!**
+
+**Want more?**
+
+- **Add a database?** → [Building a CRUD API](./building-a-crud-api.md)
+- **Production setup?** → [Complete Setup Guide](./quickstart.md) (ESLint, Prettier, etc.)
+- **Understand the architecture?** → [Core Concepts](./core-concepts/application.md)
+
+**Quick additions:**
+
+**Add a POST endpoint:**
+
+```typescript
+@post({
+  configs: {
+    path: '/greet',
+    request: {
+      body: jsonContent({
+        schema: z.object({ name: z.string() }),
+      }),
+    },
+    responses: {
+      [HTTP.ResultCodes.RS_2.Ok]: jsonContent({
+        schema: z.object({ greeting: z.string() }),
+      }),
+    },
+  },
+})
+async greet(c: Context) {
+  const { name } = await c.req.json();
+  return c.json({ greeting: `Hello, ${name}!` });
+}
+```
+
+Test it:
+
+```bash
+curl -X POST http://localhost:3000/api/hello/greet \
+  -H "Content-Type: application/json" \
+  -d '{"name":"World"}'
+```