Skip to content

docs: add agent guidance#40

Merged
mkaltner merged 3 commits into
mainfrom
agent/add-agent-guidance
Jul 17, 2026
Merged

docs: add agent guidance#40
mkaltner merged 3 commits into
mainfrom
agent/add-agent-guidance

Conversation

@mkaltner

@mkaltner mkaltner commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

What changed

  • add repository-level AGENTS.md guidance for Arcane Android
  • document the Compose architecture, SDK boundary, implementation conventions, and verification commands
  • record the collaborator workflow and publishing safety boundaries

Why

Future coding-agent sessions need durable repository context so they preserve the existing architecture, use libarcane-kotlin instead of duplicating API code, and run the same checks as CI.

Impact

Documentation only. There are no application or build-system changes.

Validation

  • git diff --cached --check
  • verified every referenced repository path exists
  • reviewed the staged scope to confirm only AGENTS.md is included

AI assistance

OpenAI Codex drafted and validated the guidance. This draft PR remains available for human review and editing.

Disclaimer Greptiles Reviews use AI, make sure to check over its work.

To better help train Greptile on our codebase, if the comment is useful and valid Like the comment, if its not helpful or invalid Dislike

To have Greptile Re-Review the changes, mention greptileai.

Greptile Summary

This PR adds agent and parity-planning documentation for Arcane Android. The main changes are:

  • Repository-level AGENTS.md guidance for architecture, SDK use, and verification.
  • A new iOS-to-Android gap analysis document.
  • A new Android iOS-parity task list derived from the gap analysis.

Confidence Score: 5/5

This looks safe to merge after the backlog consistency issues are cleaned up.

  • The changed files are documentation only.
  • The main repo guidance matches the checked Android layout and Gradle commands.
  • The parity backlog misses some work from the gap analysis and places one urgent validation task under a later phase.

docs/ios-parity-task-list.md

Fix All in Codex Fix All in Claude Code

Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
docs/ios-parity-task-list.md:75
**Missing Roadmap Tasks**

The Phase 0 backlog does not track two items that the paired gap analysis lists as immediate work: the unreachable environment list/detail/test surface and the Light/Dark/Auto appearance setting. A contributor planning from this backlog can leave those fixes unassigned, so the documented roadmap and the actionable task list diverge.

### Issue 2 of 2
docs/ios-parity-task-list.md:196-197
**Hidden Correctness Task**

`PAR-101` is marked as immediate correctness work, but it sits under the Phase 1 daily-workflow section. Planning that handles only Phase 0 first can skip the destructive prune validation even though the task itself marks that work as urgent.

Reviews (1): Last reviewed commit: "docs: add parity backlog checkboxes" | Re-trigger Greptile

Greptile also left 2 inline comments on this PR.

@mkaltner
mkaltner marked this pull request as ready for review July 17, 2026 20:17
./gradlew :app:testDebugUnitTest :app:assembleDebug
```

## Phase 0: Revalidate active history and stop correctness leaks

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing Roadmap Tasks

The Phase 0 backlog does not track two items that the paired gap analysis lists as immediate work: the unreachable environment list/detail/test surface and the Light/Dark/Auto appearance setting. A contributor planning from this backlog can leave those fixes unassigned, so the documented roadmap and the actionable task list diverge.

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/ios-parity-task-list.md
Line: 75

Comment:
**Missing Roadmap Tasks**

The Phase 0 backlog does not track two items that the paired gap analysis lists as immediate work: the unreachable environment list/detail/test surface and the Light/Dark/Auto appearance setting. A contributor planning from this backlog can leave those fixes unassigned, so the documented roadmap and the actionable task list diverge.

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Fix in Codex Fix in Claude Code

Comment on lines +196 to +197
- **Priority:** P0
- **Dependencies:** PAR-002

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Hidden Correctness Task

PAR-101 is marked as immediate correctness work, but it sits under the Phase 1 daily-workflow section. Planning that handles only Phase 0 first can skip the destructive prune validation even though the task itself marks that work as urgent.

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/ios-parity-task-list.md
Line: 196-197

Comment:
**Hidden Correctness Task**

`PAR-101` is marked as immediate correctness work, but it sits under the Phase 1 daily-workflow section. Planning that handles only Phase 0 first can skip the destructive prune validation even though the task itself marks that work as urgent.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Codex Fix in Claude Code

@mkaltner
mkaltner merged commit ca21180 into main Jul 17, 2026
3 checks passed
@mkaltner
mkaltner deleted the agent/add-agent-guidance branch July 17, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant