This repository is a knowledge base meant for audiences using AI companions to consume content.
Ping George Kary on Google Chat for help.
Follow on X for updates.
BURNOUT is an experimental project about the process of making a story, with the goal of up-skilling. It includes project updates, author’s notes, behind the scenes and materials and guides. Born out of a passion for exploring multi-disciplinary and cross-functional projects; and, of course, a love of storytelling.
A major aspect of the experiment is the use of AI for research, analysis, retrospectives, and distribution of the knowledge base. Instead of asking audiences to navigate dozens of articles, the series publishes a structured, machine-readable corpus that AI companions and other tools can explore.
If you're looking to build your own AI setup, point your AI to:
- Companion Instructions, if you're simply looking to interact with the series.
- Publisher Instructions, to update the knowledge base.
Ready to use:
- ChatGPT (Custom GPT)
Under .humans/, add any new text files for about material. Use a simple filename such as georgekary.txt or guide.txt.
Publish the update:
Run the command on the terminal yourself
chmod +x .agents/scripts/publish.sh
./.agents/scripts/publish.shPrompt your AI to do it
Publish this knowledge base update by running `./.agents/scripts/publish.sh` and following any prompts the script presents. If the script reports an error, stop and show me the complete output instead of trying to work around it.What happens, in order:
- You add human-authored source files under
.humans/. publish.shruns the orchestrator in.agents/scripts/process.py.- The processors move or generate durable assets under
vaults/burnoutseries/. - The API is rebuilt under
api/, withapi/index.jsonas the global registry andapi/burnoutseries/index.jsonas the vault-specific entrypoint. - The Custom GPT reads
api/burnoutseries/index.jsonfirst, then drills into posts, about text, or images only when needed.
flowchart LR
A[Human adds files in .humans/] --> B[Publish script runs]
B --> C[process.py orchestrates local and remote processors]
C --> D[remote/substack.py fetches Substack RSS, builds article markdown, and downloads feed images]
C --> E[local/about.py syncs about markdown and grouped JSON]
C --> F[local/vault.py writes api/index.json]
C --> G[local/index.py writes api/burnoutseries/index.json]
D --> H[api/burnoutseries/substack/articles.json + api/burnoutseries/substack/imgs.json + vault assets]
E --> I[api/burnoutseries/about/project.json + story.json + creator.json]
F --> J[api/index.json]
G --> K[api/burnoutseries/index.json]
H --> L[Custom GPT and other AI clients read the index]
I --> L
J --> L
K --> L
The knowledge base is now designed so AI companions start from api/burnoutseries/index.json.
- The index exposes
vault, including prompt guidance and navigation. - It exposes grouped
aboutandsubstackindexes withpathplusitems. - Post items include
substack_urlfor real post links. - Raw repository content should be derived from
base_url + path + file. - Public post links should come from
substack_url, not guessed website URLs.
Created and maintained together with AI. This software is protected and distributed by the PolyForm Shield License 1.0.0. Badges by shields.io.