From 310e2811b0e1776690765bcfd0ca2b85757bdb8d Mon Sep 17 00:00:00 2001 From: russellwheatley Date: Wed, 26 Aug 2026 12:28:25 +0100 Subject: [PATCH 1/2] docs: add AGENTS.md pointing at okf-bundle The bundle already exists; agents had no repo-root entry to start from. --- AGENTS.md | 15 +++++++++++++++ CLAUDE.md | 1 + 2 files changed, 16 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..67996da8e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,15 @@ +# Agent entry point + +Start at [okf-bundle/index.md](okf-bundle/index.md). + +**Before editing documentation:** read [okf-bundle/documentation-policy.md](okf-bundle/documentation-policy.md). + +For testing or module work, also read: + +* [okf-bundle/testing/change-authoring-workflow.md](okf-bundle/testing/change-authoring-workflow.md): verified change loop +* [okf-bundle/testing/agent-command-policy.md](okf-bundle/testing/agent-command-policy.md): allowlisted shell commands +* [okf-bundle/testing/validation-checklist.md](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. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 000000000..3023b3d51 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +Read [AGENTS.md](AGENTS.md) first. Follow it for this repository. From 00271b9c37ae51ea1c9a8d139421327607df06c2 Mon Sep 17 00:00:00 2001 From: Russell Wheatley Date: Wed, 26 Aug 2026 12:37:06 +0100 Subject: [PATCH 2/2] Apply suggestion from @gemini-code-assist[bot] Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- AGENTS.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 67996da8e..34482eb82 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,14 +1,14 @@ # Agent entry point -Start at [okf-bundle/index.md](okf-bundle/index.md). +Start at the [Knowledge Bundle Index](okf-bundle/index.md). -**Before editing documentation:** read [okf-bundle/documentation-policy.md](okf-bundle/documentation-policy.md). +**Before editing documentation:** read the [Documentation Policy](okf-bundle/documentation-policy.md). For testing or module work, also read: -* [okf-bundle/testing/change-authoring-workflow.md](okf-bundle/testing/change-authoring-workflow.md): verified change loop -* [okf-bundle/testing/agent-command-policy.md](okf-bundle/testing/agent-command-policy.md): allowlisted shell commands -* [okf-bundle/testing/validation-checklist.md](okf-bundle/testing/validation-checklist.md): assemble, checkstyle, unit tests, e2e +* [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.