Files
clan-core/docs/site/developer/index.md
Qubasa 5c7e6b3830 docs: Move developer guides into the Developer section
nix fmt

address davhau review
2025-07-23 18:31:19 +07:00

1.2 KiB

Developer Documentation

!!! Danger This documentation is not intended for external users. It may contain low-level details and internal-only interfaces.*

Welcome to the internal developer documentation.

This section is intended for contributors, engineers, and internal stakeholders working directly with our system, tooling, and APIs. It provides a technical overview of core components, internal APIs, conventions, and patterns that support the platform.

Our goal is to make the internal workings of the system transparent, discoverable, and consistent — helping you contribute confidently, troubleshoot effectively, and build faster.

What's Here?

!!! note "docs migration ongoing"

  • API Reference: 🚧🚧🚧 Detailed documentation of internal API functions, inputs, and expected outputs. 🚧🚧🚧
  • System Concepts: Architectural overviews and domain-specific guides.
  • Development Guides: How to test, extend, or integrate with key components.
  • Design Notes: Rationales behind major design decisions or patterns.

Who is This For?

  • Developers contributing to the platform
  • Engineers debugging or extending internal systems
  • Anyone needing to understand how and why things work under the hood