docs: Simplify repository documentation#52
Conversation
Move end-user documentation to the website and keep the repository README focused on installation, basic usage, the docs link, disclaimer, and license. Remove stale legacy markdown files from the repo and drop the deleted test README resource from SwiftPM. Co-Authored-By: Codex <noreply@openai.com>
WalkthroughThis pull request adds five new accessibility test fixture views to the AxePlaygroundApp (alert, sheet, context menu, modal navigation, and long scroll), each with corresponding navigation destinations and menu entries in the main content view. Concurrently, several documentation files are removed entirely, including BATCHING.md, TEST_RUNNER.md, Tests/README.md, USAGE_EXAMPLES.md, and an investigation report. The main README.md is substantially condensed to focus on installation and basic usage instructions. The test target configuration is updated to remove README.md from its bundled resources. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
AxePlaygroundApp/AxePlayground/Views/AccessibilityFixturesView.swift (1)
211-218: ⚡ Quick winAdd explicit accessibility identifiers to context menu actions.
Line 212 and Line 215 currently rely on button titles only. For deterministic automation fixtures, explicit IDs on these actions make targeting more robust.
Proposed diff
.contextMenu { Button("Favorite") { state = "Favorited" } + .accessibilityIdentifier("context-menu-test-favorite") Button("Archive") { state = "Archived" } + .accessibilityIdentifier("context-menu-test-archive") }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AxePlaygroundApp/AxePlayground/Views/AccessibilityFixturesView.swift` around lines 211 - 218, The context menu Buttons in AccessibilityFixturesView.swift (the contextMenu block that sets state = "Favorited"/"Archived") lack explicit accessibility identifiers; update each Button (the "Favorite" and "Archive" actions) to attach a stable identifier via .accessibilityIdentifier(...) (e.g., "contextmenu_favorite_action" and "contextmenu_archive_action") so UI tests can target them deterministically while keeping the existing titles and action closures intact.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@AxePlaygroundApp/AxePlayground/Views/AccessibilityFixturesView.swift`:
- Around line 211-218: The context menu Buttons in
AccessibilityFixturesView.swift (the contextMenu block that sets state =
"Favorited"/"Archived") lack explicit accessibility identifiers; update each
Button (the "Favorite" and "Archive" actions) to attach a stable identifier via
.accessibilityIdentifier(...) (e.g., "contextmenu_favorite_action" and
"contextmenu_archive_action") so UI tests can target them deterministically
while keeping the existing titles and action closures intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4bf27931-6025-4444-a6aa-aaa8b88808b9
📒 Files selected for processing (9)
AxePlaygroundApp/AxePlayground/ContentView.swiftAxePlaygroundApp/AxePlayground/Views/AccessibilityFixturesView.swiftBATCHING.mdPackage.swiftREADME.mdTEST_RUNNER.mdTests/README.mdUSAGE_EXAMPLES.mddocs/investigations/tabview-switching-e2e-2026-05-10.md
💤 Files with no reviewable changes (5)
- Tests/README.md
- TEST_RUNNER.md
- USAGE_EXAMPLES.md
- BATCHING.md
- docs/investigations/tabview-switching-e2e-2026-05-10.md
1 participant
Simplify the AXe repository documentation now that the full end-user docs live on axe-cli.com/docs.
The README is reduced to the repo essentials: Homebrew install commands, a short usage example, a link to the docs site, the project disclaimer, and license pointers. Legacy standalone markdown docs are removed to avoid having two competing sources of truth.
This also removes the stale SwiftPM test resource declaration for
Tests/README.md, since that file no longer exists after the cleanup.Validated with
swift test.Note
Low Risk
Mostly documentation cleanup plus non-production AxePlayground fixture additions; minimal impact on core CLI/runtime behavior. Small build risk from SwiftPM test-target resource removal and new SwiftUI routes/identifiers.
Overview
Documentation is consolidated by shrinking
README.mddown to install + minimal usage and linking out toaxe-cli.com/docs, while removing legacy markdown docs (BATCHING.md,USAGE_EXAMPLES.md,TEST_RUNNER.md,Tests/README.md, and an investigations note).AxePlayground gains new automation fixtures under a new Presentation menu section:
AlertTestView,SheetTestView,ContextMenuTestView,ModalNavigationTestView, andLongScrollTestView, each wired intoContentViewrouting with dedicated accessibility identifiers.Build/test config is tidied by removing the SwiftPM
AXeTestsresource copy for the deletedTests/README.md.Reviewed by Cursor Bugbot for commit 173b354. Bugbot is set up for automated code reviews on this repo. Configure here.