Skip to content

customization.md

Latest commit

 

History

History
128 lines (83 loc) · 3.91 KB

customization.md

File metadata and controls

128 lines (83 loc) · 3.91 KB

Customization

This guide covers how to adapt the knowledge base generator to your specific needs.

Adjusting Categories

The default categories are:

  • architecture/ — always generated
  • api/ — generated if HTTP routes found
  • domains/ — always generated
  • data-model/ — generated if migrations or ORM models found
  • infrastructure/ — generated if IaC or CI configs found

Adding Categories

To add a custom category (e.g., sdks/, integrations/, services/):

  1. When Claude presents the generation plan (Step 2), ask it to include the additional category
  2. Describe what should be included: "Add an sdks/ category covering our iOS and Android SDKs in packages/mobile-sdk/"

Claude will adapt the generation to include your custom category.

Removing Categories

Similarly, tell Claude during the plan review step:

  • "Skip the infrastructure category — we don't have IaC yet"
  • "Don't generate data model docs — we use a third-party database"

Adjusting Domain Detection

Claude identifies business domains from your directory structure. If it misidentifies or misses domains:

During Plan Review

Tell Claude:

  • "The billing/ directory is not a domain — it's a utility"
  • "Add a notifications domain from lib/notifications/ and services/notifier/"
  • "Split the users domain into authentication and user-management"

Pre-configuring Domains

You can add a domains.md file in the skill's references directory to pre-configure domain detection:

# Domain Configuration

## Domains
- authentication: `src/auth/`, `src/middleware/auth.ts`
- billing: `src/billing/`, `src/services/stripe/`
- notifications: `src/notifications/`, `src/workers/email/`

Modifying Document Format

The document format is defined in references/document-formats.md. You can modify this file to change:

  • The source attribution format
  • Required sections
  • Mermaid diagram style
  • Table conventions

Changes apply to all future generations.

Adding Tech Stack Patterns

If your tech stack isn't covered by references/category-patterns.md, add a new section:

## Elixir

### Phoenix
- **Entry points**: `lib/my_app_web/endpoint.ex`
- **Routes**: `lib/my_app_web/router.ex`
- **Controllers**: `lib/my_app_web/controllers/**/*.ex`
- **Contexts**: `lib/my_app/` (each context is a domain)
- **Schemas**: `lib/my_app/**/*_schema.ex`
- **Migrations**: `priv/repo/migrations/`

Adjusting Quality Criteria

Edit references/quality-checklist.md to change what Claude verifies for each document:

  • Remove checks that don't apply to your project
  • Add project-specific checks (e.g., "Must reference Jira ticket if applicable")
  • Adjust the minimum number of related links

Template Customization

CLAUDE.md Template

Edit assets/CLAUDE.md.template to change what goes into the generated vault's CLAUDE.md:

  • Add project-specific conventions
  • Include additional key principles
  • Customize the source code paths table

README Template

Edit assets/README.md.template to change the vault's master index format:

  • Add a project description section
  • Include team contact information
  • Add links to external resources

Running on Monorepos

For monorepos with multiple services:

  1. Point the skill at the monorepo root
  2. Claude will detect multiple services and create appropriate categories
  3. You may want to ask Claude to create per-service subdirectories within categories:
    • api/service-a/overview.md
    • api/service-b/overview.md

Alternatively, run the skill separately for each service, generating independent vaults.

Incremental Updates

To update an existing vault after codebase changes:

  1. Open Claude Code in the vault directory
  2. Tell Claude what changed: "We added a new payments domain in src/payments/"
  3. Claude will generate new documents and update existing wikilinks

Or re-run the full generation — Claude will overwrite existing files with updated content.