Repository navigation
Add comprehensive documentation and Claude skills for backend development - #15
Merged
Merged
Conversation
Document the current state of the ExApp for AI-assisted development and add reusable Claude Code tooling for it. - CLAUDE.md: the ExApp/AppAPI execution model, the API surface and its camelCase wire aliases, the ocrmypdf_parameters string contract with the workflow_ocr PHP app, error/status-code handling, the Docker build stages and the HaRP/FRP deployment path in start.sh. - .claude/skills/: add-endpoint, preflight (tests + image build + HaRP), sync-backend-contract (mirrors the skill in workflow_ocr) and run-local. - .claude/agents/: exapp-reviewer and pytest-author. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9n81aZgDyY6jdBC4yxyW6
R0Wi
marked this pull request as ready for review
September 9, 2026 18:59
Minimum allowed line rate is |
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
2 participants
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.
Summary
This change adds comprehensive documentation and Claude AI skills to guide development of the
workflow_ocr_backendExApp. It establishes clear contracts, deployment procedures, and quality gates for maintaining the REST API that serves theworkflow_ocrNextcloud app.Key Changes
CLAUDE.md: Core reference document covering the ExApp's critical constraints, stack, API surface, Docker deployment, and development conventions. Emphasizes that the API is a hand-written contract with the PHP client with no build-time validation.
Claude Skills (in
.claude/skills/):sync-backend-contract/: Verification checklist for the six-point contract between this backend and the PHP client (endpoints, multipart fields, JSON aliases, status codes, parameter parsing, versions)run-local/: Instructions for running the backend locally or in Docker and registering it as an ExApp against a Nextcloud instanceadd-endpoint/: Step-by-step guide for adding new REST endpoints, including response models, handlers, tests, and required PHP-side changespreflight/: Quality gate checklist covering unit tests, Docker builds, HaRP integration tests, and contract verificationClaude Agents (in
.claude/agents/):exapp-reviewer.md: Code review guidelines for ExApp correctness, contract compliance, error handling, OCRmyPDF usage, deployment, logging, and test coveragepytest-author.md: Test authoring conventions for the TestClient,.env-based auth headers, fixture organization, and coverage requirementsNotable Implementation Details
workflow_ocrCLAUDE.mdas the authoritative source, creating a coherent knowledge baseTestClientto be used inside awithblock to ensure lifespan handlers run, and auth headers must be built from.envvalueshttps://claude.ai/code/session_01F9n81aZgDyY6jdBC4yxyW6