Skip to content

docs: Add an AGENTS.md guide for installing, operating and developing AppAPI#911

Merged
oleksandr-nc merged 7 commits into
mainfrom
docs/appapi-agents-md
Jul 7, 2026
Merged

docs: Add an AGENTS.md guide for installing, operating and developing AppAPI#911
oleksandr-nc merged 7 commits into
mainfrom
docs/appapi-agents-md

Conversation

@oleksandr-nc

@oleksandr-nc oleksandr-nc commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

An AGENTS.md at the repo root that an AI assistant (or a person) can use as the start point for AppAPI: a zero-to-working-ExApp install path via HaRP, deploy-daemon and command references, troubleshooting, an NC33/34/35 version matrix, and a developer section (build/test/lint, CI gates, commit conventions). A thin CLAUDE.md imports it so Claude Code picks it up automatically - committing that pointer file is intentional, all content lives in AGENTS.md. Deep per-topology runbooks live under docs/appapi/ as linked spokes: Kubernetes, ExApps on a separate host, and Nextcloud AIO. Opening as a draft to keep iterating.

🤖 AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
@oleksandr-nc oleksandr-nc marked this pull request as ready for review July 7, 2026 11:57
@oleksandr-nc oleksandr-nc requested a review from kyteinsky July 7, 2026 11:57
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 934105b9-831b-4a0e-932b-59c7df34b05c

📥 Commits

Reviewing files that changed from the base of the PR and between a667787 and f112fec.

📒 Files selected for processing (7)
  • AGENTS.md
  • CLAUDE.md
  • docs/appapi/aio.md
  • docs/appapi/exapp-contract.md
  • docs/appapi/kubernetes.md
  • docs/appapi/remote-daemon.md
  • lib/DeployActions/AIODockerActions.php

📝 Walkthrough

Walkthrough

This PR adds documentation-only content for the app_api project: a new AGENTS.md root guide describing AppAPI concepts, quickstart, daemon topologies, CLI reference, runtime contract, troubleshooting, and contribution guidance; a CLAUDE.md that imports AGENTS.md; and four new runbooks under docs/appapi/ (aio.md, exapp-contract.md, kubernetes.md, remote-daemon.md) covering AIO auto-registration, the ExApp manifest contract, Kubernetes deployment via HaRP, and remote deploy daemons via FRP. Additionally, a one-line docblock update in lib/DeployActions/AIODockerActions.php clarifies that AIO detection uses the THIS_IS_AIO environment variable.

Changes

Cohort / File(s) Summary
AGENTS.md New root agent guide: quickstart, daemon topologies, CLI reference, runtime contract, troubleshooting, version notes, contributor instructions
CLAUDE.md New file importing guidance from AGENTS.md
docs/appapi/aio.md New runbook for AIO deploy daemon automation
docs/appapi/exapp-contract.md New ExApp manifest reference documentation
docs/appapi/kubernetes.md New Kubernetes/HaRP daemon runbook
docs/appapi/remote-daemon.md New remote deploy daemon (FRP) runbook
lib/DeployActions/AIODockerActions.php Docblock update for isAIO() method

Sequence Diagram(s)

Not applicable — this PR contains documentation-only content and a single docblock comment change with no observable code behavior or interaction flow.

Estimated code review effort: Low

Related issues: None specified

Related PRs: None specified

Suggested labels: documentation

Suggested reviewers: None specified

Poem

A rabbit hops through docs anew,
HaRP and daemons, k8s too,
AGENTS.md points the way,
CLAUDE.md just says "obey!"
One tiny docblock, trimmed and neat—
A burrow full of docs complete. 🐇📚

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding an AGENTS.md guide for AppAPI docs and operations.
Description check ✅ Passed The description matches the changeset, covering the AGENTS.md guide, CLAUDE.md pointer, and linked topology runbooks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@oleksandr-nc oleksandr-nc merged commit 9d321ad into main Jul 7, 2026
53 of 55 checks passed
@oleksandr-nc oleksandr-nc deleted the docs/appapi-agents-md branch July 7, 2026 12:12
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.

2 participants