Overview

Here it is, the canon‑aligned, repo‑safe, triple‑generator that automatically creates:

  • module.json
  • A_Overview.md
  • INDEX.md

together, in one pass, for every module directory.

This script is designed to live in:

docs/tools/

and works seamlessly with your existing generators.
It never overwrites existing files, respects your canon spine, and produces consistent structure across all ~200 modules.

This is the core module‑bootstrap script — the one you’ll use whenever you add new modules or rebuild the canon.


⭐ Bulk module.json + A_Overview.md + INDEX.md Generator

Save as:

docs/tools/generate_module_bundle.py

Run from repo root:

python3 docs/tools/generate_module_bundle.py

🟦 generate_module_bundle.py (Final Canon Version)#

import os
import json
 
TEMPLATE_PATH = "docs/_template/module.json"
SPINE_REF = "/docs/spine/spine.json"
 
EXCLUDED_DIRS = {
    "spine",
    "_template",
    "assets",
    "images",
    "tools"
}
 
def load_template():
    with open(TEMPLATE_PATH, "r", encoding="utf-8") as f:
        return json.load(f)
 
def is_module_dir(path):
    # A module directory is any directory containing content files
    # but NOT already containing module.json
    if "module.json" in os.listdir(path):
        return False
 
    for f in os.listdir(path):
        if f.endswith((".md", ".txt", ".json")) and f != "module.json":
            return True
 
    return False
 
def write_json(path, data):
    with open(path, "w", encoding="utf-8") as f:
        json.dump(data, f, indent=2)
 
def write_text(path, content):
    with open(path, "w", encoding="utf-8") as f:
        f.write(content)
 
def generate_module_json(path, template, name, category):
    out_path = os.path.join(path, "module.json")
 
    if os.path.exists(out_path):
        print(f"❌ module.json already exists in {path}, skipping.")
        return None
 
    data = template.copy()
 
    data["module"]["name"] = name
    data["module"]["summary"] = f"Auto‑generated module.json for {name}"
    data["module"]["category"] = category
 
    data["module"]["canon_ref"] = SPINE_REF
    data["module"]["inherit"] = {
        "canon": True,
        "session_context": True,
        "triad_alias_resolution": True
    }
 
    data["module"]["rtt"] = {
        "layer": 1,
        "source": "https://www.triadicframeworks.org/_ideas/Resonance-Time_Theory.html"
    }
 
    data["module"]["ai"] = {
        "initialization": {
            "load_spine_first": True,
            "load_canon_first": True,
            "apply_session_context": True,
            "triad_validation": True
        }
    }
 
    write_json(out_path, data)
    print(f"✔ Created {out_path}")
    return data["module"]
 
def generate_index_md(path, module):
    out_path = os.path.join(path, "INDEX.md")
 
    if os.path.exists(out_path):
        print(f"❌ INDEX.md already exists in {path}, skipping.")
        return
 
    content = f"""# {module['name']}
 
**Category:** {module['category']}  
**Summary:** {module['summary']}
 
---
 
## Canon Inheritance
This module inherits the TriadicFrameworks canon from:
 
`/docs/spine/spine.json`
 
It loads:
 
- RTT triads  
- TFT triads  
- Session context  
- RTT frozen source  
- AI initialization rules  
 
---
 
## RTT Layer
This module operates at **RTT Layer {module['rtt']['layer']}**  
Source: {module['rtt']['source']}
 
---
 
Generated automatically by `generate_module_bundle.py`.
"""
 
    write_text(out_path, content)
    print(f"✔ Created {out_path}")
 
def generate_overview_md(path, module):
    out_path = os.path.join(path, "A_Overview.md")
 
    if os.path.exists(out_path):
        print(f"❌ A_Overview.md already exists in {path}, skipping.")
        return
 
    content = f"""# {module['name']} — Overview
 
## Purpose
{module['summary']}
 
This module belongs to the **{module['category']}** domain of TriadicFrameworks.
 
---
 
## Canon Context
This module inherits the full TriadicFrameworks canon:
 
- RTT triads  
- TFT triads  
- Session context  
- RTT frozen source  
- AI initialization rules  
 
Canon reference: `/docs/spine/spine.json`
 
---
 
## RTT Layer
This module operates at **RTT Layer {module['rtt']['layer']}**.
 
---
 
Generated automatically by `generate_module_bundle.py`.
"""
 
    write_text(out_path, content)
    print(f"✔ Created {out_path}")
 
def main():
    print("\n=== TriadicFrameworks Module Bundle Generator ===\n")
 
    template = load_template()
 
    for root, dirs, files in os.walk("docs"):
        if any(ex in root for ex in EXCLUDED_DIRS):
            continue
 
        if is_module_dir(root):
            module_name = os.path.basename(root)
            module_category = os.path.basename(os.path.dirname(root))
 
            module = generate_module_json(root, template, module_name, module_category)
            if module:
                generate_index_md(root, module)
                generate_overview_md(root, module)
 
    print("\n✨ Bundle generation complete — module.json, INDEX.md, and A_Overview.md created.\n")
 
if __name__ == "__main__":
    main()

⭐ What This Script Gives You#

✔ Creates module.json, INDEX.md, and A_Overview.md together#

✔ Pulls real metadata from your template#

✔ Never overwrites existing files#

✔ Ensures canon inheritance is documented#

✔ Ensures RTT layer is documented#

✔ Ensures AI initialization context is visible#

✔ Produces consistent structure across all modules#

✔ Works across your entire /docs tree#

This is the canonical module bootstrap generator.

Was this page helpful?