infrastructure-documentation

Solid

Skill for the documentation infrastructure module providing figure management, image handling, markdown integration, and API glossary generation. Use when managing research figures, inserting images into manuscripts, auto-numbering figures, or generating API documentation.

DevOps & Infrastructure 18 stars 1 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 81/100

Stars 20%
43
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Documentation Module Figure management, image handling, and documentation integration for research manuscripts. ## GeneratedFigureRegistry (`generated_figure_registry.py`) Use the fail-closed writer for deterministic project pipelines. Figure labels, filenames, captions, and qualified generator names remain project-owned; the shared writer verifies that every declared file exists before atomically writing `output/figures/figure_registry.json`. ```python from infrastructure.documentation import publish_generated_figures written = publish_generated_figures( output_dir, PROJECT_FIGURE_SPECS, generated_paths, schema_version="my-project-figure-registry-v1", ) ``` ## FigureManager (`figure_manager.py`) Automatic figure numbering, cross-referencing, and metadata tracking: ```python from infrastructure.documentation import FigureManager, FigureMetadata manager = FigureManager() # Register a figure (label auto-generated from filename if omitted) manager.register_figure( filename="results.png", caption="Experimental results showing...", label="fig:results", section="Results", ) # Get figure metadata by label meta = manager.get_figure("fig:results") # Returns FigureMetadata | None ``` ## ImageManager (`image_manager.py`) Image file management and processing: ```python from pathlib import Path from infrastructure.documentation import ImageManager, FigureManager img_manager = ImageManager(FigureManager()) # Insert a registered figure into...

Details

Author
docxology
Repository
docxology/template
Created
11 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category