What is the primary source of truth for AGILAB documentation?

The canonical editable source is located in the thales_agilab/docs/source directory; files in the docs/html directory are generated outputs.

What happens if I accidentally edit the HTML files directly?

The skill includes a commit guardrail that requires you to discard manual edits and regenerate the files from the source to avoid stale content.

Are there privacy restrictions for AGILAB documentation?

Yes, public documentation must remain generic and cannot mention non-public applications or private internal repositories.

Which build tool is required for this documentation workflow?

This skill utilizes the uv package manager to run Sphinx builds and generate run-configuration scripts.

How do I update the documentation using this skill?

You should edit the source files, then use the build command to regenerate the HTML artifacts into the agilab repository's docs/html folder.

AGILAB Documentation Manager

Name: AGILAB Documentation Manager
Author: ThalesGroup

byThalesGroup

•

Aprendizaje y Documentación

Manages the documentation lifecycle for AGILAB by synchronizing Sphinx sources with generated HTML outputs while enforcing publication constraints.

The AGILAB Documentation Manager skill provides a standardized workflow for engineers contributing to the AGILAB project. It ensures that the 'source of truth' remains in the canonical Sphinx directories and prevents the common pitfall of manually editing generated HTML artifacts. By automating build commands via the uv package manager and enforcing strict commit guardrails, this skill maintains consistency across documentation versions and ensures that public-facing guides remain free of private repository references or non-public internal data.

Características Principales

01Enforces strict source-of-truth integrity by preventing direct edits to generated HTML files.

02Filters documentation content to comply with public-facing privacy constraints.

03Provides automated consistency checks for sidebar navigation and page labels.

04Automates Sphinx builds and local validation using the uv package manager.

05Synchronizes documentation updates between the thales_agilab source and the agilab deployment repo.

064 GitHub stars

Casos de Uso

01Updating technical engineering guides while ensuring HTML artifacts match the latest source.

02Regenerating documentation for GitHub Pages deployment after major refactors.

03Validating mathematical equations and SVG diagram rendering within Sphinx documentation.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thalesgroup/agilab agilab-docs

For use in Claude.ai and ChatGPT

Download Skill