Make README AI-native and cut v0.3.0#17
Conversation
Add an AI-native onboarding layer and prepare the 0.3.0 release. - README: new "Run It With an AI Assistant" section with a ready-to-paste prompt and an expandable, copy-paste "how do I run this?" answer block for chatbots; link AGENTS.md from the header. - AGENTS.md: root agent guide so coding agents (Codex, Claude Code, Cursor) get project overview, setup, test, run, conventions, and safety boundaries in the file they read automatically. - docs/llms.txt: "How to run" answer template for AI assistants. - docs/index.html: AI-assistant FAQ (JSON-LD + visible HTML in sync). - Bump version to 0.3.0 across bin, package.json, package-lock.json, and the GEO page; cut the 0.3.0 CHANGELOG entry dated 2026-06-30. - Update the version assertion in the Bash test suite. make test and make lint pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1a4df4a2f9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| PROGRAM="${0##*/}" | ||
| VERSION="0.2.0" | ||
| VERSION="0.3.0" |
There was a problem hiding this comment.
After bumping the script to 0.3.0, the README's codex-profile upgrade --ref v0.2.0 example now checks out a candidate older than the running version and trips the older-version guard in command_upgrade, so users copying the documented non-dry-run --ref command get a refusal instead of a working example. Update that example to a non-stale tag/placeholder as part of the release bump.
Useful? React with 👍 / 👎.
1 participant
Summary
Improves the GitHub landing page to be AI-native and prepares the v0.3.0 release.
The headline change is a clear path for AI assistants and coding agents to answer "how do I run this?" without parsing the whole README.
Landing page / AI-friendliness
🤖 Run It With an AI Assistantsection near the top: a ready-to-paste prompt to hand any chatbot/agent, plus an expandable copy-paste answer block ("Instructions for AI assistants and chatbots") with canonical install + run commands and the must-state facts (no token copying, not official OpenAI, platform support).make test/make lint, how to run, change conventions (incl. the 3-place version bump), and safety boundaries.AGENTS.md.Release v0.3.0
0.3.0acrossbin/codex-profile,package.json,package-lock.json, and the GEO pagesoftwareVersion(the GEO test asserts this matchespackage.json).0.3.0 - 2026-06-30CHANGELOG entry fromUnreleased(app-instance, npm packaging, GEO docs, and the new AI-native onboarding).Test plan
make test— passes (Bash syntax, CLI behavior, install + npm package smoke tests, GEO docs validator).make lint— passes (ShellCheck).🤖 Generated with Claude Code