# AGENTS.md — Build guide for Planable

## Project scope
Draft social content in a shared review view, preview the target format and require approval of an exact revision before scheduling. Support comments and manual export for unconnected platforms.

Catalogue verdict: kinda. The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Planable, collaboratively draft and approve social posts before manual or API publishing. The hard boundary is high-fidelity previews, approvals, comments, multiple workspaces, and client workflow, plus api access, connector upkeep, and collaboration.
Use the implementation prompt below to define the deliverable. Complete each phase's acceptance checks before extending the scope.

## Working agreement
- Inspect the repository and its existing instructions before choosing paths, dependencies or commands. Keep one coherent stack and explain changes to the proposed architecture.
- Plan a vertical slice that accepts a real input and produces the useful output described below. Persist only the state the prompt calls for; respect memory-only and upstream-managed workflows. Use fixtures only when they are clearly labelled.
- After scaffolding, document the actual install, development, check and build commands in README and keep them synchronized with the package or project manifest. Do not report commands as successful unless they ran.
- Work in small steps. At handoff, list implemented flows, checks actually performed, remaining blockers, and any credentials or provider setup the owner must supply.
- Do not publish, spend money, contact customers, delete source data or run irreversible migrations without the project owner's authorization.

## Prerequisites
- Credentials and the required API access for one chosen network. Verify permissions and quotas; provide an export/manual-post workflow for unsupported networks.
- Implementation components: Node.js, TypeScript and Express with server-rendered HTML and small browser modules. SQLite through better-sqlite3 with migrations, prepared statements and a single background worker. One official platform API adapter with declared text/media capabilities and a persisted scheduled-post worker.
- Scope boundary: high-fidelity previews, approvals, comments, multiple workspaces, and client workflow; many maintained network APIs

## Stack and architecture
- Node.js, TypeScript and Express with server-rendered HTML and small browser modules.
- SQLite through better-sqlite3 with migrations, prepared statements and a single background worker.
- One official platform API adapter with declared text/media capabilities and a persisted scheduled-post worker.
- Domain model: campaigns, platform variants, review comments, approver identities, revision hashes and publish receipts

## Security and data integrity
- Keep OAuth tokens server-side and encrypt persistent tokens with a separately managed key. Publication requires an explicit approved revision and target account.
- Correctness boundary: Any material edit after approval returns the draft to review; a publisher cannot use an approval for a different target account or revision.
- Track each target independently with pending, publishing, delivered, failed and unknown states. Reconcile a timeout using provider receipts before retrying; respect rate-limit backoff.
- Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data.

## Agent implementation rules
- Project rule — data model: campaigns, platform variants, review comments, approver identities, revision hashes and publish receipts
- Project rule — preserve this invariant: Any material edit after approval returns the draft to review; a publisher cannot use an approval for a different target account or revision.
- Project rule — acceptance evidence: Approve version one, change its text and block publication until reapproval; concurrent comments remain attached to the version reviewed.

## Optional agent skills and references
- Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
- Optional external skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review web interfaces for accessibility, keyboard focus, forms, navigation and interaction quality. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
- Optional external skill: [copywriting](https://github.com/coreyhaines31/marketingskills/blob/main/skills/copywriting/SKILL.md) — Write landing pages and product copy grounded in the intended audience, product value and a clear next action. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.

Read the linked SKILL.md and its dependencies before adding a skill. Select only the skills matching this project's runtime and task; their documentation does not supply API access, credentials or approval to perform external actions. Pin the reviewed revision where the tool supports it. Follow the chosen agent's documented project-level installation mechanism.

## Distribution ideas
These are optional planning notes. Obtain the owner's approval before publishing or contacting anyone.
- Demonstrate the actual Planable-inspired workflow with owned or clearly labeled sample data: Draft social content in a shared review view, preview the target format and require approval of an exact revision before scheduling. Support comments and manual export for unconnected platforms.
- Publish a reproducible walkthrough with this observable result: Approve version one, change its text and block publication until reapproval; concurrent comments remain attached to the version reviewed.
- Explain who can operate this scoped tool, its setup and ongoing costs, and these remaining product gaps: high-fidelity previews, approvals, comments, multiple workspaces, and client workflow; many maintained network APIs Avoid guaranteed savings, performance scores or implied endorsement.

## Engineering roadmap
1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Draft social content in a shared review view, preview the target format and require approval of an exact revision before scheduling. Support comments and manual export for unconnected platforms. Record prerequisites, select representative user-owned fixtures and document the unsupported features: high-fidelity previews, approvals, comments, multiple workspaces, and client workflow; many maintained network APIs
2. Phase 2 — Durable model. Model campaigns, platform variants, review comments, approver identities, revision hashes and publish receipts Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: Any material edit after approval returns the draft to review; a publisher cannot use an approval for a different target account or revision.
3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Track each target independently with pending, publishing, delivered, failed and unknown states. Reconcile a timeout using provider receipts before retrying; respect rate-limit backoff.
4. Phase 4 — Permissions and integration failure. Keep OAuth tokens server-side and encrypt persistent tokens with a separately managed key. Publication requires an explicit approved revision and target account. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results.
5. Phase 5 — Portable handoff. Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README.
6. Phase 6 — Acceptance scenarios. Approve version one, change its text and block publication until reapproval; concurrent comments remain attached to the version reviewed. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder.

## Paid-product capabilities outside this build
- high-fidelity previews, approvals, comments, multiple workspaces, and client workflow
- many maintained network APIs
- inbox and moderation
- deep analytics
- team approvals and asset libraries

## Implementation prompt
WORKING SLICE
Draft social content in a shared review view, preview the target format and require approval of an exact revision before scheduling. Support comments and manual export for unconnected platforms.

Build this scoped Planable-inspired workflow with a documented data model and visible failure states.

Architecture
- Node.js, TypeScript and Express with server-rendered HTML and small browser modules.
- SQLite through better-sqlite3 with migrations, prepared statements and a single background worker.
- One official platform API adapter with declared text/media capabilities and a persisted scheduled-post worker.

Prerequisites and limits
Credentials and the required API access for one chosen network. Verify permissions and quotas; provide an export/manual-post workflow for unsupported networks.
Outside this release: high-fidelity previews, approvals, comments, multiple workspaces, and client workflow; many maintained network APIs

Data model and correctness
campaigns, platform variants, review comments, approver identities, revision hashes and publish receipts
Invariant: Any material edit after approval returns the draft to review; a publisher cannot use an approval for a different target account or revision.
Track each target independently with pending, publishing, delivered, failed and unknown states. Reconcile a timeout using provider receipts before retrying; respect rate-limit backoff.

Security and privacy
Keep OAuth tokens server-side and encrypt persistent tokens with a separately managed key. Publication requires an explicit approved revision and target account.

Recovery and export
Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data.

Implementation order
1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Draft social content in a shared review view, preview the target format and require approval of an exact revision before scheduling. Support comments and manual export for unconnected platforms. Record prerequisites, select representative user-owned fixtures and document the unsupported features: high-fidelity previews, approvals, comments, multiple workspaces, and client workflow; many maintained network APIs
2. Phase 2 — Durable model. Model campaigns, platform variants, review comments, approver identities, revision hashes and publish receipts Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: Any material edit after approval returns the draft to review; a publisher cannot use an approval for a different target account or revision.
3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Track each target independently with pending, publishing, delivered, failed and unknown states. Reconcile a timeout using provider receipts before retrying; respect rate-limit backoff.
4. Phase 4 — Permissions and integration failure. Keep OAuth tokens server-side and encrypt persistent tokens with a separately managed key. Publication requires an explicit approved revision and target account. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results.
5. Phase 5 — Portable handoff. Use a consistent SQLite backup and an attachment manifest. Export portable JSON/CSV, then restore to a new directory without overwriting the original data. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README.
6. Phase 6 — Acceptance scenarios. Approve version one, change its text and block publication until reapproval; concurrent comments remain attached to the version reviewed. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder.

Acceptance
Approve version one, change its text and block publication until reapproval; concurrent comments remain attached to the version reviewed.
Use real source data or clearly labeled fixtures. Explain unsupported input and provider failures; do not fabricate analytics, delivery receipts, accuracy claims or security guarantees.

Optional agent guidance
Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Optional external skill: [web-design-guidelines](https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md) — Review web interfaces for accessibility, keyboard focus, forms, navigation and interaction quality. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Optional external skill: [copywriting](https://github.com/coreyhaines31/marketingskills/blob/main/skills/copywriting/SKILL.md) — Write landing pages and product copy grounded in the intended audience, product value and a clear next action. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Project rule — data model: campaigns, platform variants, review comments, approver identities, revision hashes and publish receipts
Project rule — preserve this invariant: Any material edit after approval returns the draft to review; a publisher cannot use an approval for a different target account or revision.
Project rule — acceptance evidence: Approve version one, change its text and block publication until reapproval; concurrent comments remain attached to the version reviewed.

## Completion evidence
Demonstrate the prompt's acceptance scenarios against the scoped workflow. Include setup from a clean checkout and failure recovery. Check persistence across restart and export/restore only for the state the prompt says to store; for memory-only tools, confirm that temporary content is discarded as specified. Record actual results and remaining limitations. A detailed plan alone does not establish a working replacement.