Skip to content

Comments

Add comprehensive AI agent guide for FluxStack framework#62

Merged
MarcosBrendonDePaula merged 1 commit intomainfrom
claude/create-agent-documentation-SAcVZ
Feb 14, 2026
Merged

Add comprehensive AI agent guide for FluxStack framework#62
MarcosBrendonDePaula merged 1 commit intomainfrom
claude/create-agent-documentation-SAcVZ

Conversation

@MarcosBrendonDePaula
Copy link
Collaborator

Summary

This PR adds a comprehensive guide document (LLMD/agent.md) designed to help AI agents assist developers with FluxStack projects. The guide provides detailed instructions, templates, and best practices for working with the FluxStack full-stack TypeScript framework.

Key Changes

  • New Agent Guide (LLMD/agent.md): 867-line comprehensive reference covering:

    • Agent identity and role definition
    • Complete technology stack overview (Bun, Elysia.js, React, Vite, TypeScript, Tailwind, Eden Treaty, Vitest)
    • Project architecture and fundamental rules (core/ read-only, app/ read-write)
    • Detailed workflow guides for common tasks:
      • Initial project setup
      • Creating REST API routes with proper schemas
      • Building Live Components with WebSocket real-time sync
      • Configuration management with declarative system
      • Plugin development and auto-discovery
      • Authentication patterns (REST and Live Components)
    • Reusable code templates for CRUD routes, controllers, and tests
    • Import alias conventions and CLI commands
    • Critical rules (10 "never do" and 10 "always do" items)
    • Troubleshooting decision tree
    • Context-based guidance for architectural decisions
    • Quality checklist for implementations
  • Updated Navigation (LLMD/INDEX.md): Added link to new agent guide at the top of quick navigation

Implementation Details

The guide is structured to be:

  • LLM-optimized: Clear sections, code examples, and decision trees for AI parsing
  • Comprehensive: Covers all major FluxStack features and patterns
  • Practical: Includes working code templates and real-world scenarios
  • Prescriptive: Establishes clear rules and best practices to prevent anti-patterns
  • Navigable: Cross-references to other documentation and organized by workflow

The document serves as a reference for AI agents to understand FluxStack conventions, architecture, and best practices when assisting developers with project setup, code generation, and troubleshooting.

https://claude.ai/code/session_01U1k7i5BtNzP8bnriD6uq61

Provides a complete reference for AI agents helping developers configure
and build FluxStack applications, including workflows, code templates,
diagnostic trees, and critical rules.

https://claude.ai/code/session_01U1k7i5BtNzP8bnriD6uq61
@MarcosBrendonDePaula MarcosBrendonDePaula merged commit e935e8f into main Feb 14, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants