This repository hosts Apik’s internal engineering documentation — our shared technical foundation for all teams.
It defines our development standards, workflows, tooling, and infrastructure guidelines, ensuring coherence and quality across projects.
The full documentation lives in the /docs directory and is automatically deployed to GitHub Pages at:
👉 https://apikcloud.github.io/docs/
Every developer should be able to understand, extend, or debug any Apik project without friction.
This documentation captures our collective know-how and evolves continuously through collaboration.
All documentation, code comments, and commit messages are written in English.
French versions are generated automatically for internal readability when needed.
/docs— Core documentation (development, workflow, CI/CD, quality, infrastructure, etc.)/docs/_media— Shared assets (logos, diagrams, images)/docs/_sidebar.md— Documentation sidebar structure/docs/index.html— Docsify configuration for live rendering/docs/DOCUMENTATION.md— Aggregated documentation (auto-generated, do not edit manually)/scripts— Automation scripts for translation and aggregation.github/workflows— CI pipelines for translation, validation, and aggregation
The old _module/ folder has been merged into a single file: 10-module.md.
Two main GitHub Actions maintain the documentation:
| Workflow | Description |
|---|---|
| Translate | Generates a French version from the English source. (deactivated) |
| Aggregate | Builds a single Markdown file for offline use. (deactivated) |
| pages-build-deployment | Deploys the documentation to GitHub Pages. |
This documentation is a living reference.
All contributions must go through Pull Request review by the Quality Team and, when applicable, the Technical Referent.
Guidelines:
- Keep edits concise, consistent, and in English.
- Reference related tickets or discussions in commit messages.
- Keep branches short-lived: merge early, merge often.
- Each branch should focus on a single, clear topic.
- Avoid long-running branches or parallel document versions.
- Documentation changes are collaborative but should remain traceable and easy to review.
The documentation repository follows a trunk-based development workflow similar to our Odoo projects, with lightweight and short-lived branches.
mainis the source of truth and represents the published version of the documentation (public or internal).
Branches are created for short, focused contributions and merged quickly into main using squash merges.
Use clear and thematic prefixes instead of ticket-based names:
| Prefix | Purpose | Example |
|---|---|---|
doc/ |
New documentation page or section | doc/hooks, doc/migrations |
fix/ |
Minor fix or correction | fix/typo, fix/links |
rev/ |
Major revision or restructuring | rev/architecture, rev/sections-order |
draft/ |
Work in progress, not yet validated | draft/quality-charter |
This convention keeps the documentation process consistent with our trunk-based philosophy while staying lightweight and contributor-friendly.
make setup
make serve# To aggregate and translate documentation manually
make translate
make aggregateAny unvalidated or in-progress document must begin with this badge:
<mark>Status: Draft — Pending Review and Approval</mark>This clearly indicates that the page is provisional and subject to review.
This repository is distributed under the CC BY-NC-ND 4.0 License.