docs(readme): correct CI workflow list + add AGENTS.md - #22
Merged
Conversation
Replace the stale GitHub Workflows subsection. Drop the non-existent release.yml reference, drop the false "Checks code quality" claim, and accurately describe android-ci.yml and release-manual.yml.
Operating context for AI agents: project overview, architecture, build/verify commands, Kotlin/Go conventions, and common footguns.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The README's "GitHub Workflows" section (
README.md:309-326) made two false claims:References a non-existent
release.ymlworkflow. The repo only hasandroid-ci.ymlandrelease-manual.yml—release.ymlwas deleted at some point but the README still listed it.Claims
android-ci.yml"Checks code quality". It only builds the debug APK (and now runs unit tests after PR fix(android): VpnTileService dispatcher ordering + CI Go 1.25 alignment #17). No lint step exists.Changes
README.md — replaced the entire "GitHub Workflows" subsection
android-ci.yml: Accurately describes trigger (push tomain/master+ PRs), AAR build, debug APK build, unit tests, artifact upload.release-manual.yml: Describesworkflow_dispatchinputs (tag_name,release_name,make_latest), signing secrets required, release asset upload viasoftprops/action-gh-release@v2.release.ymland how to perform tag-triggered releases.AGENTS.md — new file (repo root)
Operating context for AI agents (opencode, Cursor, Claude Code, etc.):
go vet/gofmtengine.Stop()panics, cleartextnetwork_security_config.xml, stale Go mobile AARplans/— references theplans/directory indexEliminates redundant recon work for future agent-assisted development sessions.