Development guide

Resources for contributing to AlignTrue and understanding the codebase.

Getting started

• Setup - Local development environment setup
• Workspace - Monorepo structure and package organization
• Commands - Build, test, and development commands
• Architecture - System design and technical decisions

Quick links

Contributing

• Getting started guide - How to contribute
• Testing workflow - Running and writing tests
• Adding exporters - Creating new agent adapters

Documentation

• Editing docs - How to update documentation
• Creating packs - Publishing rule packs

Development workflow

1. Clone and setup: Follow the setup guide
2. Make changes: Edit code in relevant package
3. Test locally: Run tests with pnpm test
4. Build: Run pnpm build to verify compilation
5. Submit PR: Follow contributing guidelines

Package structure

AlignTrue uses a pnpm workspace with the following packages:

• packages/cli - Command-line interface
• packages/core - Core sync engine and configuration
• packages/schema - IR validation and canonicalization
• packages/exporters - Agent-specific exporters (43 adapters)
• packages/markdown-parser - Markdown to IR conversion
• packages/sources - Multi-source pulling (local, git, catalog)
• apps/docs - Documentation site (Nextra)

See workspace guide for detailed package descriptions.