{"id":38552210,"url":"https://github.com/apikcloud/docs","last_synced_at":"2026-01-17T07:36:50.367Z","repository":{"id":320651424,"uuid":"966761263","full_name":"apikcloud/docs","owner":"apikcloud","description":"The Apik Way","archived":false,"fork":false,"pushed_at":"2025-12-18T11:15:04.000Z","size":493,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-21T01:43:00.506Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://apikcloud.github.io/docs/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apikcloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-15T12:18:01.000Z","updated_at":"2025-12-15T12:08:38.000Z","dependencies_parsed_at":"2026-01-06T11:11:22.675Z","dependency_job_id":null,"html_url":"https://github.com/apikcloud/docs","commit_stats":null,"previous_names":["apikcloud/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/apikcloud/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apikcloud%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apikcloud%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apikcloud%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apikcloud%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apikcloud","download_url":"https://codeload.github.com/apikcloud/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apikcloud%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28504356,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation"],"created_at":"2026-01-17T07:36:50.264Z","updated_at":"2026-01-17T07:36:50.349Z","avatar_url":"https://github.com/apikcloud.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/apikcloud/docs/main/docs/_media/logo.png\" alt=\"Apik Logo\" width=\"180\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/apikcloud/docs/main/docs/_media/compass.png\" alt=\"Compass\" width=\"500\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/apikcloud/docs/actions\"\u003e\u003cimg alt=\"CI\" src=\"https://img.shields.io/github/actions/workflow/status/apikcloud/docs/ci.yml?label=CI\"\u003e\u003c/a\u003e\n  \u003ca href=\"./LICENSE\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/badge/license-MIT-blue.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"./docs\"\u003e\u003cimg alt=\"Docs\" src=\"https://img.shields.io/badge/docs-available-brightgreen\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## Overview\n\nThis repository hosts **Apik’s internal engineering documentation** — our shared technical foundation for all teams.  \nIt defines our **development standards**, **workflows**, **tooling**, and **infrastructure guidelines**, ensuring coherence and quality across projects.\n\nThe full documentation lives in the `/docs` directory and is automatically deployed to GitHub Pages at:  \n👉 [https://apikcloud.github.io/docs/](https://apikcloud.github.io/docs/)\n\n---\n\n## Philosophy\n\nEvery developer should be able to understand, extend, or debug any Apik project without friction.  \nThis documentation captures our collective know-how and evolves continuously through collaboration.\n\n---\n\n## Working Language\n\nAll documentation, code comments, and commit messages are written in **English**.  \nFrench versions are generated automatically for internal readability when needed.\n\n---\n\n## Structure\n\n- `/docs` — Core documentation (development, workflow, CI/CD, quality, infrastructure, etc.)  \n- `/docs/_media` — Shared assets (logos, diagrams, images)  \n- `/docs/_sidebar.md` — Documentation sidebar structure\n- `/docs/index.html` — [Docsify](https://docsify.js.org/) configuration for live rendering\n- `/docs/DOCUMENTATION.md` — Aggregated documentation (auto-generated, do not edit manually)\n- `/scripts` — Automation scripts for translation and aggregation\n- `.github/workflows` — CI pipelines for translation, validation, and aggregation\n\nThe old `_module/` folder has been merged into a single file: `10-module.md`.\n\n---\n\n## Automation\n\nTwo main GitHub Actions maintain the documentation:\n\n| Workflow | Description |\n|-----------|--------------|\n| **Translate** | Generates a French version from the English source. (deactivated) |\n| **Aggregate** | Builds a single Markdown file for offline use. (deactivated) |\n| **pages-build-deployment** | Deploys the documentation to GitHub Pages. |\n\n\n---\n\n## Contributing\n\nThis documentation is a **living reference**.  \nAll contributions must go through **Pull Request** review by the **Quality Team** and, when applicable, the **Technical Referent**.\n\n**Guidelines:**\n- Keep edits **concise**, **consistent**, and **in English**.  \n- Reference related tickets or discussions in commit messages.  \n- Keep branches short-lived: merge early, merge often.  \n- Each branch should focus on a single, clear topic.  \n- Avoid long-running branches or parallel document versions.\n- Documentation changes are collaborative but should remain traceable and easy to review.\n\n### Branch Naming Convention\n\nThe documentation repository follows a **trunk-based development workflow** similar to our Odoo projects, with lightweight and short-lived branches.\n\n#### Main branch\n- **`main`** is the source of truth and represents the published version of the documentation (public or internal).\n\n#### Working branches\nBranches are created for short, focused contributions and merged quickly into `main` using **squash merges**.\n\nUse clear and thematic prefixes instead of ticket-based names:\n\n| Prefix | Purpose | Example |\n|---------|----------|----------|\n| `doc/` | New documentation page or section | `doc/hooks`, `doc/migrations` |\n| `fix/` | Minor fix or correction | `fix/typo`, `fix/links` |\n| `rev/` | Major revision or restructuring | `rev/architecture`, `rev/sections-order` |\n| `draft/` | Work in progress, not yet validated | `draft/quality-charter` |\n\n\n_This convention keeps the documentation process consistent with our trunk-based philosophy while staying lightweight and contributor-friendly._\n\n### Running Locally\n```bash\nmake setup\nmake serve\n```\n\n```bash\n# To aggregate and translate documentation manually\nmake translate\nmake aggregate\n```\n\n---\n\n## Drafts and Proposals\n\nAny unvalidated or in-progress document must begin with this badge:\n\n```markdown\n\u003cmark\u003eStatus: Draft — Pending Review and Approval\u003c/mark\u003e\n```\n\nThis clearly indicates that the page is **provisional** and subject to review.\n\n---\n\n## License\n\nThis repository is distributed under the [CC BY-NC-ND 4.0 License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapikcloud%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapikcloud%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapikcloud%2Fdocs/lists"}