Skip to content

Conversation

@pyramation
Copy link
Contributor

Add comprehensive AGENTS.md navigation documentation

Summary

This PR adds a comprehensive navigation system for AI agents working with the LaunchQL codebase. It includes:

  • Root AGENTS.md: Navigation router for the entire monorepo with package categorization and quick-start guidance
  • packages/core/AGENTS.md: Detailed guide for LaunchQLPackage and LaunchQLMigrate classes with methods, workflows, and usage patterns
  • packages/cli/AGENTS.md: CLI command patterns, structure, and integration with core classes
  • packages/pgsql-test/AGENTS.md: Testing infrastructure guide covering getConnections(), seeding strategies, and RLS testing

The documentation covers all 38 packages in the monorepo, categorized by functionality (Core, API/Server, Testing, Database, Streaming, etc.) with cross-references and common workflow examples.

Review & Testing Checklist for Human

  • Verify file paths and class references - Check that referenced files like packages/core/src/core/class/launchql.ts and packages/core/src/migrate/client.ts exist and contain the mentioned classes
  • Validate method signatures - Spot-check that LaunchQLPackage and LaunchQLMigrate methods (like deploy(), getModuleMap(), verify()) match their actual implementations
  • Test code examples - Try running a few of the TypeScript code examples to ensure they're syntactically correct and work as documented
  • Review package categorization - Verify that the 38 packages are correctly categorized and that critical packages aren't missing from the navigation
  • Check workflow accuracy - Validate that the documented workflows (module development, testing, migration) reflect actual LaunchQL usage patterns

Notes

This documentation was created to help AI agents navigate the codebase without reading everything. Since it's based on code exploration rather than runtime testing, accuracy verification is important. The documentation should significantly improve agent productivity when working with LaunchQL.

Requested by: Dan Lynch ([email protected])
Link to Devin run: https://app.devin.ai/sessions/d59a0763f09841ef844aee5466ae57c1

- Create root AGENTS.md as navigation router for entire LaunchQL codebase
- Document all 38 packages with categorization and quick-start guidance
- Add detailed packages/core/AGENTS.md covering LaunchQLPackage and LaunchQLMigrate classes
- Add packages/cli/AGENTS.md documenting CLI command patterns and structure
- Add packages/pgsql-test/AGENTS.md for testing infrastructure guidance
- Include common workflows, usage patterns, and debugging tips
- Provide cross-references and navigation aids between packages
- Help agents quickly find relevant code without reading everything

Co-Authored-By: Dan Lynch <[email protected]>
@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation closed this Sep 16, 2025
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