Skyflow Platform Documentation
Technical documentation, Architecture Decision Records (ADRs), and runbooks for the Skyflow platform.Documentation Overview
This repository contains all technical documentation for the Skyflow platform, organized to help engineers understand, operate, and contribute to the system.Sections
| Section | Description |
|---|---|
| Architecture | System architecture, diagrams, and technical design |
| ADRs | Architecture Decision Records documenting key technical decisions |
| Runbooks | Operational runbooks for incident response and maintenance |
| API | API documentation and specifications |
| Onboarding | New developer setup and onboarding guides |
Quick Links
Contributing
We welcome contributions to improve our documentation. Please follow these guidelines:General Guidelines
- Keep it current: Update documentation when you make changes to the system
- Be clear and concise: Write for your fellow engineers
- Include examples: Code samples and diagrams help understanding
- Link related docs: Cross-reference related documentation
Making Changes
- Create a branch from
main - Make your documentation changes
- Ensure markdown linting passes
- Submit a pull request with a clear description
- Request review from the appropriate team
ADR Contributions
When making significant architectural decisions:- Copy the ADR template
- Number your ADR sequentially (e.g.,
0002-my-decision.md) - Fill in all sections
- Submit for review before implementation
Style Guide
- Use Markdown
- Use Mermaid for diagrams
- Follow the existing document structure
- Use sentence case for headings
- Include a table of contents for long documents