[uniskela]

Summary

• Split documentation into docs/public/, docs/internal/ and docs/agents/ so the publisher can import user docs and reject maintainer and agent sources.
• Published pages keep their existing slugs. Setup, deployment, backups, security and the other user-facing references stay under docs/public/, including the roadmap at plans/mvp-plan.
• Implementation plans and architecture decisions, including ADR 0005, move under docs/internal/. Root AGENTS.md stays the canonical agent guide; docs/agents/README.md only points at it and the product-boundary docs.

Test plan

• pnpm check
• pnpm build
• Confirm the docs manifest still lists the same slugs after review
• After merge, let the Uniskela docs sync import docs/public/ and confirm internal and agent paths are not published

Made with Cursor

Summary by CodeRabbit

• Documentation
  • Clarified the separation between public user documentation, internal plans and architecture materials, and agent guidance.
  • Updated documentation indexes, links, and publishing guidance to reflect the new organization. Published page URLs remain unchanged.
• Tests
  • Added checks for published documentation listings and broken or invalid Markdown links.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 70c2e0a1-ef73-4d02-907d-eb90a89b3207

📥 Commits

Reviewing files that changed from the base of the PR and between a06799f and 3d5ca34.

📒 Files selected for processing (54)

• .github/docs-sync.md
• AGENTS.md
• README.md
• docs/agents/README.md
• docs/internal/DEPLOYMENT_ROUTING.md
• docs/internal/DEPLOYMENT_WATCH.md
• docs/internal/INDEX.md
• docs/internal/PRIOR_ART.md
• docs/internal/UX.md
• docs/internal/adr/0001-tech-stack.md
• docs/internal/adr/0002-persisted-jobs.md
• docs/internal/adr/0003-editor-codemirror.md
• docs/internal/adr/0004-modular-monolith.md
• docs/internal/adr/0005-product-boundary.md
• docs/internal/domain/DATA_MODEL.md
• docs/internal/plans/2026-09-30-dashboard-stacks-settings-design.md
• docs/internal/plans/2026-09-30-dashboard-stacks-settings-implementation.md
• docs/internal/plans/2026-09-30-stacks-ui-audit-and-plan.md
• docs/internal/plans/UI_UX_PLAN.md
• docs/internal/providers/DEPLOYMENT_PROVIDER.md
• docs/internal/providers/GIT_PROVIDER.md
• docs/internal/providers/RUNTIME_PROVIDER.md
• docs/internal/providers/SECRET_PROVIDER.md
• docs/manifest.json
• docs/public/ARCHITECTURE.md
• docs/public/AUTH_AND_CREDENTIALS.md
• docs/public/BACKUP_RESTORE.md
• docs/public/GIT_WORKFLOW.md
• docs/public/PRODUCT.md
• docs/public/RELEASING.md
• docs/public/SECURITY.md
• docs/public/SELF_HOSTING.md
• docs/public/STACK_DISCOVERY.md
• docs/public/TESTING.md
• docs/public/getting-started.md
• docs/public/index.md
• docs/public/installation.md
• docs/public/plans/MVP_PLAN.md
• next.config.ts
• src/app/w/[workspaceId]/stacks/[stackId]/environment/page.tsx
• src/server/application/credential-service.ts
• src/server/application/source-service.ts
• src/server/application/stack-service.ts
• src/server/domain/git-repository.ts
• src/server/domain/job.ts
• src/server/domain/stack.ts
• src/server/persistence/schema.ts
• src/server/providers/git/types.ts
• src/server/security/network-policy.ts
• src/server/security/password.ts
• src/ui/source/stack-discovery.tsx
• src/ui/source/stack-editor.tsx
• src/ui/source/stack-tabs.tsx
• tests/unit/docs-layout.test.ts

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The changes organize documentation into public, internal, and agent locations. They update publishing guidance, manifest sources, documentation links, and source comments to use the new paths. Unit tests check the manifest layout and relative Markdown links.

Changes

Documentation layout

Layer / File(s)	Summary
Publishing guidance and manifest .github/docs-sync.md, AGENTS.md, README.md, docs/agents/README.md, docs/manifest.json	Guidance distinguishes published pages under docs/public/, internal documents under docs/internal/, and agent notes under docs/agents/. Manifest source paths now point to public pages; page metadata remains unchanged.
Documentation navigation and links docs/internal/INDEX.md, docs/internal/plans/*, docs/internal/providers/GIT_PROVIDER.md, docs/public/ARCHITECTURE.md, docs/public/SELF_HOSTING.md, docs/public/STACK_DISCOVERY.md, docs/public/installation.md	Indexes, plans, and page links now use the reorganized paths. Installation links point to the repository-root Compose file and .env.example.
Code documentation references next.config.ts, src/app/.../environment/page.tsx, src/server/application/*, src/server/domain/*, src/server/persistence/schema.ts, src/server/providers/git/types.ts, src/server/security/*, src/ui/source/*	Comments and documentation references now point to public or internal documentation paths. The summaries report no runtime behavior changes.
Documentation layout tests tests/unit/docs-layout.test.ts	Tests check the published slug list, manifest sources, selected documentation references, and relative Markdown links for missing or repository-escaping targets.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 3d5ca

No actionable issue is established before merge. Confirm after merge that the documentation sync publishes only the public pages.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 16 files. (14 skipped:…	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: separating public, internal, and agent documentation.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 16 files. (14 skipped: 14 unsupported.)

• Fix all pre-merge checks with AI

✨ Finishing Touches 💡 2

📝 Generate docstrings 💡

• Commit to this branch
• Create a new PR

🛠️ Fix failing CI checks 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Add Carrot credits or activate Agent usage billing to use Autopilot