> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blitzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Knowledge Base

> Browse, search, and manage your technical specifications library organized by repository and branch

The technical specifications represents Blitzy's detailed understanding of each codebase's architecture, patterns, conventions, domain terminology, and technical constraints. Toggle to [Workspace](/platform/workspace) to write generation prompts.

<Note>
  **Jump to:** [Why](#why-the-knowledge-base-matters) • [How](#using-the-knowledge-base) • [Example](#practical-example)
</Note>

## Why the Knowledge Base Matters

The Knowledge Base serves as the foundation for high-quality AI-Native code generation. Here's why it's critical to operational success:

**Key capabilities:**

* Live documentation that automatically syncs with code changes
* Repository and branch organization using `{repo_name}/{branch_name}` format
* Structured [9-section specification format](/project-lifecycle/tech-spec-review) covering architecture to infrastructure
* Seamless workspace integration for context review and code generation

<Tabs>
  <Tab title="Code Generation Quality">
    - **Determines output quality** -Well-documented specs produce accurate, contextually appropriate code matching your existing patterns
    - **Reduces iteration cycles** -Complete specs mean correct code on the first attempt, minimizing rework
    - **Ensures architectural consistency** -All generated code follows established patterns, preventing drift
  </Tab>

  <Tab title="Team Productivity">
    * **Accelerates onboarding** -New team members gain instant understanding of codebase architecture and conventions
    * **Living documentation** -Always-current docs that evolve with your codebase, replacing months of manual effort
    * **Facilitates code reviews** -Reviewers reference specs to validate that code follows established patterns
  </Tab>

  <Tab title="Business Value">
    * **Rapid legacy understanding** -Comprehensive documentation of undocumented codebases created in days, not months
    * **Supports compliance** -Documents security patterns, audit requirements, and regulatory constraints
    * **Accelerates delivery** -Engineers spend less time understanding context and more time building features
  </Tab>

  <Tab title="Multi-Repository Management">
    * **Organized by repo and branch** -Clean separation using `{repo_name}/{branch_name}` format
    * **VCS integration** -Filter by GitHub, GitLab, or Bitbucket to focus on specific platforms
    * **Cross-repository understanding** -See how microservices and shared libraries relate across your organization
  </Tab>
</Tabs>

## Using the Knowledge Base

### Sidebar Organization

The Knowledge Base sidebar displays your complete technical specifications library with powerful filtering and organization:

<CardGroup cols={3}>
  <Card title="Tech Specs Count" icon="hashtag">
    Total number of specifications you have access to, updating dynamically as you apply filters.
  </Card>

  <Card title="Filters" icon="filter">
    Narrow by VCS platform (GitHub, GitLab, Bitbucket), project name, or teams with access.
  </Card>

  <Card title="Naming Format" icon="tag">
    Each spec follows `{repo_name}/{branch_name}` format for instant context on repository and branch.
  </Card>
</CardGroup>

### Browsing Specifications

Select any specification from the sidebar to view a comprehensive technical specification document. The spec opens with all 9 sections (Introduction through Appendices) fully expanded, providing deep context for effective generation prompts and understanding how new code integrates with existing patterns.

<Warning>
  [Read your tech spec](/project-lifecycle/tech-spec-review). The better you know what Blitzy knows, the better the code it writes.
</Warning>

### Search and Discovery

**Within Specifications**

* Search for specific patterns, classes, functions, or architectural decisions
* Navigate directly to relevant sections (e.g., jump to "System Architecture" or "Technology Stack")
* Find domain terminology in the Glossary (Section 9.2)
* Review architecture diagrams in Quick Reference (Section 9.4)

### When to Use the Knowledge Base

<Tabs>
  <Tab title="Before Generation">
    Review specifications before writing prompts to ensure you understand:

    * Current architectural patterns you should follow
    * Existing conventions for file organization and naming
    * Domain terminology to use in your requests
    * Technical constraints that must be respected
  </Tab>

  <Tab title="During Code Review">
    Reference specifications when reviewing generated code to verify:

    * Code follows documented architectural patterns
    * Naming conventions match existing standards
    * Domain terminology is used correctly
    * Technical constraints are respected
  </Tab>

  <Tab title="Team Onboarding">
    Share specifications with new team members to accelerate onboarding:

    * Comprehensive codebase overview
    * Documented architectural decisions and rationale
    * Domain-specific terminology explanations
    * Code organization patterns
  </Tab>

  <Tab title="Architectural Planning">
    Consult specifications when planning new features to:

    * Understand existing architectural patterns
    * Identify integration points
    * Evaluate consistency with current conventions
    * Plan changes that align with established patterns
  </Tab>
</Tabs>

### Getting Started

<Steps>
  <Step title="Access Knowledge Base">
    Toggle from Workspace to Knowledge Base using the UI toggle in the platform.
  </Step>

  <Step title="View Your Specifications Library">
    The sidebar shows your total tech specs count and all specifications in `{repo_name}/{branch_name}` format.
  </Step>

  <Step title="Apply Filters (Optional)">
    Use filters to narrow down by VCS, project name, or teams with access to find relevant specifications.
  </Step>

  <Step title="Select a Specification">
    Click any `{repo_name}/{branch_name}` entry to view its complete technical specification.
  </Step>

  <Step title="Review the Specification">
    Browse through the 9 sections: Introduction, Product Requirements, Technology Stack, Process Flowcharts, System Architecture, Components Design, UI Design, Infrastructure, and Appendices.
  </Step>

  <Step title="Navigate to Relevant Sections">
    Jump directly to sections like "System Architecture" (Section 5) for patterns or "Appendices" (Section 9) for glossary terms.
  </Step>

  <Step title="Search Within Specifications">
    Use search to find specific patterns, classes, or architectural decisions across all sections.
  </Step>

  <Step title="Apply Knowledge in Workspace">
    Toggle back to Workspace to create generation requests informed by your specification review.
  </Step>
</Steps>

## Practical Example

You need to add a new payment processing feature to an existing e-commerce platform, but you're unfamiliar with the codebase architecture. Here's how the Knowledge Base helps:

<Accordion title="Full Walkthrough: Payment Feature Using Knowledge Base">
  **1. Toggle to Knowledge Base** -Access from the Workspace toggle; see total specs in the sidebar.

  **2. Locate the Specification** -Find `ecommerce-platform/main` in the sidebar or use "Filter by Project Name."

  **3. Review System Architecture (Section 5)** -Learn the platform uses a three-tier architecture: Controllers → Services → Repositories. See `PaymentGatewayService` as the payment hub.

  **4. Check Product Requirements (Section 2)** -Review existing payment features, functional requirements, and implementation considerations for new payment methods.

  **5. Consult Appendices - Glossary (Section 9)** -Discover that "Order" and "Transaction" are distinct concepts; learn payment method types and fraud detection terminology.

  **6. Examine Components Design (Section 6)** -Review PCI-DSS compliance requirements, tokenization specs, and audit logging requirements.

  **7. Study Process Flowcharts (Section 4)** -Review payment processing workflows, error handling, and state management for transactions.

  **8. Review Technology Stack (Section 3)** -Check existing payment libraries, framework versions, and integration points with payment providers.

  **9. Toggle Back to Workspace** -Return with comprehensive understanding across all 9 specification sections.

  **10. Create Informed Generation Request** -Write a prompt referencing the three-tier architecture, correct domain terminology, PCI-DSS requirements, existing payment workflows, and the technology stack.
</Accordion>

The specification review enables a high-quality generation prompt that produces code matching existing patterns on the first attempt, avoiding multiple refinement cycles.

## Advanced Features

<Tabs>
  <Tab title="Multi-Repository">
    See all repositories in one view with `{repo_name}/{branch_name}` format. Filter by VCS platform (GitHub, GitLab, Bitbucket), team access, or project name. Understand how microservices relate to shared libraries across your organization.

    See the [Git Submodules Integration Guide](/administration/submodules) for configuration.
  </Tab>

  <Tab title="Branch Management">
    Each branch has its own specification listed as `{repo_name}/{branch_name}`. Compare branches side-by-side (e.g., `ecommerce-platform/main` vs `ecommerce-platform/develop`), track feature branch specs, and understand how branches diverge.
  </Tab>

  <Tab title="Auto Sync">
    Specifications automatically sync with code changes as they happen. Each branch maintains its own up-to-date spec. Changes to patterns, frameworks, conventions, and domain terminology are reflected without manual maintenance.
  </Tab>

  <Tab title="Export">
    Export specifications for team onboarding, architectural decision records, external reviews with architects or consultants, and compliance audits.
  </Tab>
</Tabs>

## Best Practices

<CardGroup cols={2}>
  <Card title="Before Every Generation" icon="magnifying-glass">
    Review relevant specs, understand existing patterns, reference domain terminology, and check technical constraints before writing prompts.
  </Card>

  <Card title="During Code Review" icon="code-compare">
    Keep Knowledge Base open in a separate tab. Reference specs to validate generated code follows documented patterns and terminology.
  </Card>

  <Card title="Team Collaboration" icon="users">
    Share spec links when discussing architecture. Reference Knowledge Base during planning meetings as shared vocabulary.
  </Card>

  <Card title="Specification Quality" icon="star">
    Keep code well-organized, use `.blitzyignore` to exclude irrelevant files, and add meaningful comments explaining architectural decisions.
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Specification appears incomplete">
    * Verify you're viewing the correct branch (`{repo_name}/{branch_name}`)
    * Check that relevant files aren't excluded by `.blitzyignore`
    * Use an [ingestion prompt](/prompt-engineering/ingestion) to provide business context and domain knowledge beyond static analysis
    * For submodules, ensure they are [correctly synced](/administration/submodules) with proper access granted
  </Accordion>

  <Accordion title="Specification quality needs improvement">
    Use an [ingestion prompt](/prompt-engineering/ingestion) to improve specification quality by providing:

    * Business context and domain terminology
    * Compliance requirements (HIPAA, GDPR, SOC 2)
    * Architectural rationale and evolution
    * Guidance on what code patterns to focus on or ignore
  </Accordion>

  <Accordion title="Can't find a repository">
    * Verify repository access in [Integration settings](/integrations/managing)
    * Confirm correct VCS organization/account is connected
    * For submodules, see the [Git Submodules guide](/administration/submodules)
  </Accordion>

  <Accordion title="Branch not showing">
    * Confirm branch exists in source control and is synced to remote
    * Verify you have access permissions for the branch
    * Check that branch isn't excluded by repository configuration
  </Accordion>
</AccordionGroup>

***

**Need help?** Contact support at [support@blitzy.com](mailto:support@blitzy.com) or consult your Blitzy AI Solutions Consultant for Knowledge Base configuration assistance.