Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

ASAP Documentation

Welcome. This folder holds the technical documentation for the ASAP project. End-user product docs live on asap.cool/docs and are not part of this repo.

Pick your path

If you are… Start here
Self-hosting ASAP on your own infrastructure self-hosting/installation.md
Contributing to the codebase development/architecture.md, then ../CONTRIBUTING.md
Integrating with the API development/api.md
Looking into a specific feature design features/
Reviewing architecture decisions development/decisions/

Layout

docs/
├── self-hosting/        Operators: install, configure, upgrade
├── development/         Contributors: architecture, API, testing, ADRs
└── features/            Per-feature design docs (AI, extensions, PWA, …)

The repository root holds the public-facing files: README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, CHANGELOG.md, LICENSE.

Status

ASAP is pre-1.0. Some documents are inherited from earlier internal work and are progressively being rewritten in English with the current architecture. Open an issue if something is unclear or out of date.

Out of scope

Roadmap, business strategy, and internal implementation plans are tracked outside of this repo. Public-facing roadmap items live in GitHub Issues and Projects.