Skip to content

docs: add AGENTS.md pointing at okf-bundle #2456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
russellwheatley merged 2 commits into from
Aug 26, 2026
+16 −0
Merged

docs: add AGENTS.md pointing at okf-bundle #2456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
310e281
docs: add AGENTS.md pointing at okf-bundle
russellwheatley Aug 26, 2026
00271b9
Apply suggestion from @gemini-code-assist[bot]
russellwheatley Aug 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Agent entry point

Start at the [Knowledge Bundle Index](okf-bundle/index.md).

**Before editing documentation:** read the [Documentation Policy](okf-bundle/documentation-policy.md).

For testing or module work, also read:

* [Change Authoring Workflow](okf-bundle/testing/change-authoring-workflow.md): verified change loop
* [Agent Command Policy](okf-bundle/testing/agent-command-policy.md): allowlisted shell commands
* [Validation Checklist](okf-bundle/testing/validation-checklist.md): assemble, checkstyle, unit tests, e2e

Human onboarding (JDK, Android Studio, `./scripts/build.sh`): [CONTRIBUTING.md](CONTRIBUTING.md) owns that content; do not duplicate here.

User-facing product behavior: [README.md](README.md) and [GETTING_STARTED.md](GETTING_STARTED.md) own that content; do not duplicate here.
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Read [AGENTS.md](AGENTS.md) first. Follow it for this repository.
Loading