Skip to content

docs: Overhaul and rename agent guide#3757

Merged
jamesarich merged 1 commit into
mainfrom
chore/agents
Nov 20, 2025
Merged

docs: Overhaul and rename agent guide#3757
jamesarich merged 1 commit into
mainfrom
chore/agents

Conversation

@jamesarich

Copy link
Copy Markdown
Collaborator

The AGENT.md file has been renamed to AGENTS.md and its content has been completely rewritten to serve as a comprehensive guide for AI agents and developers.

Key changes include:

  • A new, structured format with sections for Project Overview, Codebase Map, Development Guidelines, and Quality Assurance.
  • Detailed instructions on UI development, state management, navigation, and dependency management.
  • Specific commands for building, testing, and linting (spotlessApply, detekt).
  • Clarification on build variants (google, fdroid) and the centralized string resource system.
  • An "Agent Workflow" section to guide automated development processes.

The `AGENT.md` file has been renamed to `AGENTS.md` and its content has been completely rewritten to serve as a comprehensive guide for AI agents and developers.

Key changes include:
- A new, structured format with sections for Project Overview, Codebase Map, Development Guidelines, and Quality Assurance.
- Detailed instructions on UI development, state management, navigation, and dependency management.
- Specific commands for building, testing, and linting (`spotlessApply`, `detekt`).
- Clarification on build variants (`google`, `fdroid`) and the centralized string resource system.
- An "Agent Workflow" section to guide automated development processes.

Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
@jamesarich jamesarich added documentation Improvements or additions to documentation chore labels Nov 20, 2025
@jamesarich jamesarich merged commit 1b512c6 into main Nov 20, 2025
5 of 7 checks passed
@jamesarich jamesarich deleted the chore/agents branch November 20, 2025 20:17
@codecov

codecov Bot commented Nov 20, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.56%. Comparing base (295753d) to head (b4a5125).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main   #3757   +/-   ##
=====================================
  Coverage   0.56%   0.56%           
=====================================
  Files        381     381           
  Lines      21733   21733           
  Branches    2684    2684           
=====================================
  Hits         122     122           
  Misses     21591   21591           
  Partials      20      20           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant