Skip to content

EKGF/ekg-catalog

Repository files navigation

catalog

Catalog and repository for components of the Enterprise Knowledge Graph.

Python

This repo uses Python 3.14+ (see pyproject.toml) and uv.

uv sync

Use case mindmaps & metadata

  • Use case Markdown files under docs/use-case/**/index.md must include frontmatter with title, description, keywords, and parents. Allowed parents values: .. (direct parent directory) or absolute /use-case/... for cross-tree “used by” parents. Siblings cannot be parents; the build will fail if encountered.

  • During uv run mkdocs serve|build, docs/main.py normalizes frontmatter (deriving missing fields from H1 and first paragraph), builds the use case graph, and regenerates collision-free PlantUML mindmaps under docs/diagrams/src/, overwriting stale use-case mindmaps.

  • To regenerate mindmaps and frontmatter outside MkDocs:

    cd docs && python3 - <<'PY'
    from main import _build_graph, _write_pumls
    graph = _build_graph()
    _write_pumls(graph)
    print(f"Processed {len(graph)} use cases")
    PY
  • Each parent shown in a mindmap includes all its children; multiple parents are supported (primary rendered first).

This is an initiative of:

The content of this repository is published as https://catalog.ekgf.org

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Contributors 2

  •  
  •