Home

🛡️ Welcome to the Badge Gen Wiki

Welcome to the official documentation space for Badge Gen. This framework is a production-ready toolkit designed to bridge the gap between developer workflows and fully automated, non-destructive documentation maintenance.

🧭 Navigation Map

To help you get the most out of the system, we have structured our manual into dedicated execution layers:

1. 🚀 Architecture Overview Learn how the interaction between Python, Bash, and the Makefile keeps the core code intact while remaining extensible.
2. 💡 Static Stack & Tech Badges Master the generation of colored tech-stack elements and license discovery automations.
3. 📊 Dynamic Metrics & Sections Configure API integration keys safely to inject dynamic execution states and batch matrix tables.
4. 🏢 Enterprise Scalability Discover structural strategies to implement the toolkit inside Git Submodules, Monorepos, or centralized DevOps pipelines.
5. 🤖 Advanced CI-CD Engineering Understand how environment detection, git auto-commits, and automated tag version increments operate on the cloud.

---

🛠️ Global Shorthand Checklist

If your local development workspace is initialized with .venv, remember your primary commands available via the compile layer:

• make install -> Provisions environment dependencies.
• make lint -> Checks code metrics via Black and Flake8.
• make test -> Triggers the 21-test validation suite (95%+ code coverage).
• make top -> Re-injects centered HTML <img /> badges into your document header.
• make clean -> Purges scattered test logs and bytecode artifacts.

---

💻 Local Wiki Development & Offline Editing

For maintainers who prefer staging mass documentation overhauls, writing markdown inside a local IDE (like VS Code), or linting text assets offline, GitHub exposes the Wiki structure as a dedicated, fully independent Git repository.

1. Cloning the Documentation Tree

To download the entire text repository locally, clone the hidden .wiki.git endpoint using your Personal Access Token (PAT) for credentials verification:

git clone https://github.com
cd bagde-gen.wiki

2. Internal Files Layout Mapping

Once downloaded, the folder reveals a clean flat structure of pure markdown elements:

bagde-gen.wiki/
├── _Sidebar.md                             # Custom vertical navigation map
├── Home.md                                 # This greeting page
├── Architecture-Overview.md                # System decoupled tiers layout
├── Static-Stack-and-Tech-Badges.md         # Custom styling configurations
├── Dynamic-Metrics-and-Sections.md         # API secrets ingestion metrics
└── Enterprise-Scalability-and-Integration.md # Submodule & Monorepo architectures

3. Staging and Syncing Back to GitHub

You can add pages by creating .md files or modify text strings locally. To push updates back to the cloud live environment, run the standard Git cycle:

git status
git add .
git commit -m "docs: enrich scalability deployment modules details"
git push origin master

(Note: Most GitHub Wikis use 'master' as their default primary branch track instead of 'main').