Skip to content

CLAUDEDB

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

CLAUDEDB

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
API.md
API.md
 
 
CONCEPTS.md
CONCEPTS.md
 
 
INDEX.md
INDEX.md
 
 
README.md
README.md
 
 
TASKS.md
TASKS.md
 
 
VERIFICATION.md
VERIFICATION.md
 
 

README.md

CLAUDEDB - O(1) Knowledge Access System

Created: 2025-11-22 Purpose: Instant navigation to Reactium/Actinium framework documentation Location: /home/john/reactium-framework/CLAUDEDB/

What is CLAUDEDB?

CLAUDEDB is an index layer that provides O(1) (constant-time) access to the comprehensive framework documentation in /CLAUDE/. Instead of scanning through large documentation files, you can:

  1. Look up a keyword → Get direct link to exact section
  2. State your task → Get implementation guide
  3. Find a concept → Get learning path
  4. Search an API → Get function signature + documentation

File Structure

CLAUDEDB/
├── README.md       # This file - explains the system
├── INDEX.md        # Keyword → Section links (alphabetical)
├── TASKS.md        # "I need to..." → Implementation guides
├── CONCEPTS.md     # Concept → Multi-step learning paths
└── API.md          # Function signatures + documentation links

Reference Documentation (DO NOT MODIFY)

CLAUDE/
├── FRAMEWORK_DOCUMENTATION_INDEX.md
├── REACTIUM_FRAMEWORK.md
├── ACTINIUM_COMPLETE_REFERENCE.md
├── ACTINIUM_FRAMEWORK.md
├── FRAMEWORK_INTEGRATION.md
├── FRAMEWORK_PATTERNS.md
├── FRAMEWORK_GOTCHAS.md
├── HOOK_DOMAINS_DEEP_DIVE.md
├── ZONE_SYSTEM_DEEP_DIVE.md
├── ZONE_SYSTEM_QUICK_REFERENCE.md
├── ROUTING_SYSTEM.md
├── REACTIUM_WEBPACK.md
├── REGISTRY_SYSTEM.md
├── REACTIUM_SOURCE_CODE_ANALYSIS.md
└── KNOWN_ISSUES.md

How to Use CLAUDEDB

Scenario 1: You Know a Keyword

Example: "What are Capabilities?"

  1. Open CLAUDEDB/INDEX.md
  2. Search for "Capabilities" (Ctrl+F / Cmd+F)
  3. Click link: [Actinium: Capabilities System](../CLAUDE/ACTINIUM_COMPLETE_REFERENCE.md#capabilities-system)
  4. Read the exact section needed

Zero scanning required - direct to answer.

Scenario 2: You Have a Task

Example: "I need to create a Cloud Function"

  1. Open CLAUDEDB/TASKS.md
  2. Go to "Build Something" section
  3. Find "Create a Cloud Function"
  4. Follow links to:
    • Quick reference for immediate implementation
    • Patterns for best practices
    • Integration guide for frontend usage

Task-oriented navigation - organized by what you're trying to accomplish.

Scenario 3: You Want to Learn a Concept

Example: "How does the Zone System work?"

  1. Open CLAUDEDB/CONCEPTS.md
  2. Find "Zone System" section
  3. Follow the learning path (6 steps from basics to advanced):
    • Step 1: Complete architecture overview
    • Step 2: API reference
    • Step 3: Core architecture details
    • Step 4: Filters, mappers, sorters
    • Step 5: Common patterns
    • Step 6: Performance optimization

Guided learning - step-by-step progression from beginner to expert.

Scenario 4: You Need API Documentation

Example: "What's the signature for Hook.register?"

  1. Open CLAUDEDB/API.md
  2. Find "Hooks" section
  3. See signature with parameters: 
    Reactium.Hook.register(
    name,           // string
    callback,       // async function
    priority,       // number (default: Enums.priority.neutral)
    id,             // string (optional, auto-generated)
    domain          // string (default: 'default')
)
  4. Click link for detailed documentation

Quick reference - function signature + detailed docs, all in one place.

Design Principles

1. O(1) Access

Every lookup goes directly to the answer - no scanning, no searching multiple files.

2. Single Source of Truth

CLAUDEDB files link to CLAUDE/ documentation. They don't duplicate content. All links use format:

[Link Text](../CLAUDE/FILE.md#section-anchor)

3. Developer Workflow Organization

CLAUDEDB is organized by how developers think (tasks, concepts, keywords), not by framework architecture.

4. Zero Duplication

Content lives in CLAUDE/ only. CLAUDEDB provides navigation.

5. Synonym Awareness

Common synonyms map to the same target:

  • Authorization = Permissions = Capabilities
  • Backend = Actinium
  • Frontend = Reactium

When to Use Each File

Use INDEX.md when:

  • You know a keyword/term and want its definition
  • You're searching alphabetically
  • You want to check synonyms
  • Example: "What is a Handle?"

Use TASKS.md when:

  • You have a specific thing to build
  • You're asking "How do I...?"
  • You want implementation steps
  • Example: "How do I create a route?"

Use CONCEPTS.md when:

  • You want to learn a concept thoroughly
  • You need step-by-step understanding
  • You're planning architecture
  • Example: "How does state management work?"

Use API.md when:

  • You need a function signature
  • You want quick API reference
  • You're looking up parameters
  • Example: "What are the Hook.register parameters?"

Examples

Quick Lookup Workflow

User: "How do I check capabilities in a Cloud Function?"

  1. Open CLAUDEDB/API.md
  2. Search "Capability Checking"
  3. See signature: 
    const { CloudHasCapabilities } = Actinium.Utils;
if (!CloudHasCapabilities(req, 'feature.use')) {
    throw new Error('Permission denied');
}
  4. Click link for full documentation
  5. Total time: 30 seconds

Learning Workflow

User: "I want to understand the Zone System"

  1. Open CLAUDEDB/CONCEPTS.md
  2. Find "Zone System" learning path
  3. Follow 6-step progression:
    • Read Deep Dive for architecture
    • Study Quick Reference for API
    • Review Core Architecture
    • Learn Filters/Mappers/Sorters
    • Study Common Patterns
    • Optimize Performance
  4. Structured learning from beginner to expert

Task Workflow

User: "I need to create a backend plugin with SDK"

  1. Open CLAUDEDB/TASKS.md
  2. Go to "Build Something → Create a backend plugin"
  3. Follow links:
    • Essential Plugin Structure (quick start)
    • Plugin System (detailed guide)
    • Plugin SDK Pattern (best practices)
  4. Implementation-focused, step-by-step

Coverage

INDEX.md

  • 100+ keywords with direct links
  • Synonym mapping for common terms
  • Alphabetically organized for fast lookup

TASKS.md

  • 60+ common tasks organized by category
  • Build, Work with Data, Auth, Real-Time, UI, Hooks, Build/Deploy, Debug, Optimize, Learn
  • Task-oriented organization

CONCEPTS.md

  • 25+ major concepts with learning paths
  • Multi-step progression from basics to advanced
  • Reactium, Actinium, Integration, and Cross-cutting concepts

API.md

  • 60+ API functions with signatures
  • Parameter documentation
  • Return value documentation
  • Usage examples

Maintenance

When to Update CLAUDEDB

Update CLAUDEDB when:

  1. New major features are added to CLAUDE/ documentation
  2. Common developer questions reveal missing index entries
  3. New patterns emerge that deserve dedicated learning paths
  4. API signatures change

How to Update

  1. Add new keywords to INDEX.md (alphabetical order)
  2. Add new tasks to TASKS.md (category-based)
  3. Add new concepts to CONCEPTS.md (with learning paths)
  4. Add new APIs to API.md (with signatures)

Always link to CLAUDE/ files - never duplicate content.

Link Format

Always use relative links with section anchors:

[Link Text](../CLAUDE/FILE.md#section-anchor)

Examples:

  • [Reactium: Hook System](../CLAUDE/REACTIUM_FRAMEWORK.md#hook-system)
  • [Actinium: Capabilities](../CLAUDE/ACTINIUM_COMPLETE_REFERENCE.md#capabilities-system)
  • [Zone System Deep Dive](../CLAUDE/ZONE_SYSTEM_DEEP_DIVE.md)

Testing the Index

To verify CLAUDEDB works correctly:

  1. Pick a random keyword from INDEX.md → Click link → Should go directly to section
  2. Pick a random task from TASKS.md → Click link → Should show implementation
  3. Pick a random concept from CONCEPTS.md → Follow learning path → Should build understanding
  4. Pick a random API from API.md → Click link → Should show detailed docs

Goal: Zero scanning, zero searching. One click to answer.

Philosophy

Traditional documentation forces you to:

  1. Guess which file has the information
  2. Open the file
  3. Scan for the section
  4. Read until you find the answer

CLAUDEDB enables you to:

  1. Look up keyword/task/concept
  2. Click direct link
  3. Read exact answer

Result: 10x faster knowledge access, especially for AI assistants and developers new to the framework.

For AI Assistants (Claude)

When a user asks a question:

  1. Start with CLAUDEDB - check INDEX, TASKS, or CONCEPTS first
  2. Get the direct link to the relevant CLAUDE/ section
  3. Read that specific section for the answer
  4. Provide the answer with file path + section anchor

Example workflow:

  • User: "How do I create a route with data loading?"
  • Claude: Check CLAUDEDB/TASKS.md → "Create a route with data loading"
  • Claude: Read CLAUDE/REACTIUM_FRAMEWORK.md#data-loading-with-loadstate
  • Claude: Provide answer with reference

Efficiency gain: Instead of reading 3-4 entire documentation files (thousands of lines), read ONE specific section (50-100 lines).

Summary

CLAUDEDB is your instant navigation system for Reactium/Actinium framework documentation:

  • INDEX.md - Keyword lookup (100+ terms)
  • TASKS.md - Task-based navigation (60+ tasks)
  • CONCEPTS.md - Learning paths (25+ concepts)
  • API.md - Function reference (60+ APIs)

All organized for O(1) access to the comprehensive CLAUDE/ documentation.

Happy navigating!