> For the complete documentation index, see [llms.txt](https://hotwax.adarshraghuwanshi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hotwax.adarshraghuwanshi.com/readme.md). # Introduction Welcome to the **GitBook Docs Assignment** repository! This repository serves as the central **source-of-truth** for our project documentation, which is automatically synced in real-time with our live **GitBook space**. This onboarding guide is designed to help you quickly understand the repository structure, configure your local environment, write standard-compliant documentation, and understand the automated GitBook integration pipeline. *** ## 🏗️ Repository Architecture This repository follows standard GitBook structures. Keeping files properly organized ensures that both human readers and automated parsers can navigate the workspace easily. ``` . ├── README.md # 👈 Onboarding guide (this file) ├── SUMMARY.md # 👈 Navigation configuration & Table of Contents ├── structure.md # 👈 Guide on page organization and layout ├── navigation.md # 👈 Sidebar and right-hand TOC guidelines └── advanced-features/ # 👈 Parent directory for advanced content ├── README.md # 👈 Overview of advanced Markdown features ├── callouts.md # 👈 Specifications for custom alerts/tips └── tables.md # 👈 Rules for data tables and code formatting ``` | Path | Purpose | Format | | --------------------- | ---------------------------------------------------------- | ------------- | | `/README.md` | Primary developer and onboarding guide (local only). | Markdown | | `/SUMMARY.md` | Maps the sidebar tree structure inside the GitBook portal. | Markdown List | | `/*.md` | Top-level documentation pages. | Markdown | | `/advanced-features/` | Categorized sub-directory for advanced components. | Directory | *** ## 🔄 Automated GitBook Integration We leverage **GitBook's Native GitHub Integration** to enable a continuous deployment workflow for our documentation. ### The Ingestion Pipeline ```mermaid graph TD A[Developer edits Markdown locally] --> B[Commit and Push to 'main' branch] B --> C[GitHub Webhook fires] C --> D[GitBook parses SUMMARY.md] D --> E[GitBook updates live site in real-time] style A fill:#e1f5fe,stroke:#0288d1,stroke-width:2px style B fill:#e8f5e9,stroke:#388e3c,stroke-width:2px style C fill:#fff9c4,stroke:#fbc02d,stroke-width:2px style D fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px style E fill:#ffe0b2,stroke:#f57c00,stroke-width:2px ``` * **Main Branch**: Only push production-ready documentation to `main`. Every push immediately goes live. * **Feature Branches**: For major changes or restructuring, create a branch, submit a Pull Request, and review the changes prior to merging. *** ## 🛠️ Getting Started & Local Preview To edit and preview your changes locally before committing: ### 1. Prerequisites Ensure you have the following installed on your system: * **Git** (for version control) * **Node.js** (for running local markdown lint or preview tools) ### 2. Local Preview While GitBook automatically compiles the files on push, you can preview the markdown files in your favorite editor (e.g., VS Code's Markdown Preview) or run a local static preview server: ```bash # Preview via standard terminal viewer or markdown parsers # For VS Code, use the shortcut: Ctrl + Shift + V (Cmd + Shift + V on macOS) ``` *** ## ✍️ Contribution Guidelines & Styling Rules To maintain high visual quality and standard reading experience across all pages, please adhere to these formatting guidelines: ### 1. Modifying the Sidebar (`SUMMARY.md`) The sidebar structure must reflect a nested hierarchy. Rather than flat lists, group related pages under a non-clickable category list label: ```markdown * Parent Category Name * [First Child Page](path/to/child.md) * [Second Child Page](path/to/child-2.md) ``` ### 2. Using Custom Callouts / Alerts Use GitBook-style alerts to emphasize important concepts. Standard markdown blockquotes combined with special syntax are rendered beautifully: ```markdown > [!INFO] > Use this for key facts or side-notes. > [!TIP] > Use this to share productivity shortcuts or best practices. > [!WARNING] > Use this to warn about actions that can disrupt or break things. ``` ### 3. Data Tables & Code Syntax Always include table alignment headers and specify language types for all code blocks to ensure syntax highlighting works: ```javascript // Example: Always specify 'javascript', 'html', or 'bash' after the triple backticks const ready = true; ``` *** > \[!IMPORTANT] **Checklist before submitting a Pull Request:** > > 1. Did you verify that your page is correctly linked in `/SUMMARY.md`? > 2. Are all relative links between files working as expected? > 3. Does your new page start with a single, clear `

` title? --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://hotwax.adarshraghuwanshi.com/readme.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.