Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xxyoudeadpunkxx/ai-protocol-kit/llms.txt

Use this file to discover all available pages before exploring further.

This stack is for anyone preparing a GitHub repository for public or clean publication with AI assistance. Whether you are pushing a new project for the first time or cleaning up an existing repository before sharing it, this sequence closes publication risks — workspace hygiene, file decisions, GitHub feature choices, README fit, and optional signal decisions — before any git action is taken. Each protocol controls a distinct layer of the work so nothing important gets skipped or assumed.
1

GitHub Repository Publication Preparation Protocol v2

Classify the project, audit the workspace and risks, design the publication model, and generate only what is justified. This protocol controls the session: it runs the audit, surfaces decisions that need to be made before a commit or push, and gates execution until those decisions are answered.View protocol →
2

GitHub README Framing and Authoring Protocol v2

Derive the correct README from real project evidence, the real reader, and the real job the README must perform. This protocol controls the artifact: it prevents writing from vague intent, wrong reader assumptions, or inflated framing disconnected from what the repository actually contains.View protocol →
3

GitHub Badge, Telemetry & Counter Protocol v1.2.3 (conditional)

Add this step only if badges, counters, analytics, or validation checks are actually needed for the repository. This protocol decides which signals are justified and which are vanity — it is not a default step and should not be added unless there is a genuine reason for signals.View protocol →
The badge and telemetry protocol is conditional. Only add it if signals — badges, counters, analytics, or validation checks — are actually justified for this repository. Most repositories do not need it. Adding it by default produces noise, not signal.
Stacking rule: Step 1 controls the session. Step 2 controls the artifact. Run them in order — the publication audit in Step 1 shapes the constraints that Step 2’s README must satisfy. Do not run Step 2 before Step 1 is complete.

​
When to use this stack

  • Publishing a new repository for the first time and want to avoid common publication mistakes
  • Cleaning up an existing repository before sharing it publicly or linking it from other surfaces
  • Preparing a project for open-source release, where README quality, workspace hygiene, and feature choices matter
  • Any situation where “just push it” carries real risks you want closed before the commit

Build docs developers (and LLMs) love

Get started for freeTalk to us