Quatico Development Guidelines
This is the central documentation website for Quatico Solutions' development tools, guidelines, and best practices.
This website is built using Docusaurus, a modern static website generator, and serves as the starting point for developers at Quatico.
Two Main Sections
📚 Development Practices
Essential guides and resources for day-to-day development work at Quatico:
- Commit Notation: Arlo's commit notation system for risk assessment and code review
- Jest Testing Guide: Comprehensive unit testing guide with stubs, spies, and mocks
- CLAUDE.md Setup: Creating AI coding assistant instructions for your projects
- pnpm Package Manager: Package management reference and best practices
Plus links to additional resources and Confluence pages for development tools, practices, infrastructure, and more.
🔧 Developing this documentation project
Information about the documentation project itself - how to work with it, contribute to it, and extend it:
- Getting Started: Set up the documentation project locally and understand the build process
- Updating Documentation: Learn how to update documentation for existing projects (Magellan, Webbloqs, Proxies)
- Integrating Projects: Step-by-step guide to add a new project to the documentation website
- Documentation Meta: Technical details about creating documents and pages in Docusaurus
Accessing Documentation
Internal Documentation (TEST Environment)
If you work at Quatico, you can access internal and pre-release documentation at:
- Q-TEST Environment: Internal documentation with all guides and resources
Public Documentation
- docs.quatico.dev: Public-facing documentation (no internal content)
Quick Links
- Tool Documentation: Magellan, Webbloqs, Proxies
- Development Practices: Start with Commit Notation or Jest Testing
- Contributing: See Getting Started to set up the project locally