aieos-exportar

Generates mkdocs.yml from on-disk content and validates the MkDocs build.

Updated Aug 3, 2026
One-click install
npx skills add https://github.com/GuilhermeBrancalhao/ENGINE-CODEX --skill aieos-exportar-guilhermebrancalhao
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: aieos-exportar
Source: https://github.com/GuilhermeBrancalhao/ENGINE-CODEX/tree/main/acervo/.claude/skills/aieos-exportar
Command: npx skills add https://github.com/GuilhermeBrancalhao/ENGINE-CODEX --skill aieos-exportar-guilhermebrancalhao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires mkdocs, mkdocs-material.

What problem does it solve? Publishing a documentation archive as a MkDocs site requires a navigation file that matches what actually exists on disk. Hand-written nav entries drift from reality, producing menu items that point to pages that do not exist, and a generated config alone does not prove the site builds. ## Core Features & Use Cases - Disk-derived navigation: Runs python -m ferramentas.exportar to write mkdocs.yml with a nav built only from volumes and sections that exist as files, never from declared-but-unmaterialized content. - Optional strict build validation: When mkdocs is on the PATH, the tool runs mkdocs build --strict and reports one of three outcomes: generated and validated, generated but not validated (mkdocs missing, exit 0), or generated but build failed (exit 1). - Honest reporting rules: The skill mandates explicit wording about whether the build was validated, forbidding claims like "exported successfully" when mkdocs was not installed. - Use Case: After adding chapters to the AI-ENGINEERING-OS archive, run the export to regenerate the site config and confirm with a strict build that no Mermaid syntax errors, broken relative links, or orphaned sections slipped in. ## Quick Start Run the exportar skill from inside the AI-ENGINEERING-OS directory to generate mkdocs.yml and report whether the strict MkDocs build was validated, skipped, or failed.

Frequently Asked Questions about aieos-exportar

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a mkdocs.yml navigation from existing files?▼

Run python -m ferramentas.exportar from inside the AI-ENGINEERING-OS directory. It writes mkdocs.yml with a fixed header plus a nav built from disk: the introduction first, then materialized volumes in id order, including only sections that exist as files.

How do I validate a MkDocs site build strictly?▼

The export tool automatically runs mkdocs build --strict when the mkdocs executable is found on the PATH, using a temporary config file outside the root. If validation passes it prints a success message; if it fails the exit code is 1.

Why does the export report success but say the build was not validated?▼

Exit code 0 with the warning message means mkdocs is not installed, so only mkdocs.yml was generated. The site was not built or checked. Install mkdocs and mkdocs-material with pip to enable strict build validation.

Why is a declared volume missing from the generated MkDocs nav?▼

Navigation is derived from disk, not from declarations. A volume declared in its metadata but lacking actual section files is excluded. Confirm with python -m ferramentas.status that the volume has present sections, not just a _VOLUME.yml file.

Can I edit mkdocs.yml manually to fix a build failure?▼

No. The file header states it is generated by ferramentas/exportar.py and must not be edited by hand, because the next run overwrites manual changes. Fix the underlying content or nav source instead, then rerun the export.