Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goakt.dev/llms.txt

Use this file to discover all available pages before exploring further.

We welcome contributions—bug fixes, features, and documentation improvements. This section helps collaborators get started.

​
Prerequisites

  • Docker
  • make (pre-installed on macOS and most Linux distributions)
All developer tooling (Go, buf, mockery, golangci-lint, openssl) runs inside a Docker image built by the Makefile. No additional local installs are required.

​
Before you start

  1. Read the Architecture Document to understand the codebase
  2. Check existing issues and discussions
  3. Follow Conventional Commits for commit messages

​
How to contribute

  1. Fork the repository
  2. Create a branch for your change
  3. Make your changes; ensure tests pass: make test
  4. Commit with a conventional commit message
  5. Open a pull request to the main branch
  6. For bug fixes, leave a working sample in the playground package per its instructions

​
Key documents