chore: moving towards agentic development
This commit is contained in:
@@ -1,32 +1,40 @@
|
||||
# Docs
|
||||
|
||||
This folder contains the project documentation used to guide product, implementation, and architecture work.
|
||||
This folder contains the project documentation used to guide product, implementation, architecture, and agentic development work.
|
||||
|
||||
## Current Product Docs
|
||||
## Start Here
|
||||
|
||||
- [product/vision.md](/home/jbourdon/repos/social-media/docs/product/vision.md): current product intent, users, scope, and priorities.
|
||||
- [product/glossary.md](/home/jbourdon/repos/social-media/docs/product/glossary.md): canonical domain vocabulary. Prefer these terms in code, UI copy, and specs.
|
||||
- [constraints.md](/home/jbourdon/repos/social-media/docs/constraints.md): business and technical invariants that should not be violated casually.
|
||||
- [AGENTIC_WORKFLOW.md](/home/jbourdon/repos/social-media/docs/AGENTIC_WORKFLOW.md): human + agent development loop.
|
||||
- [ARCHITECTURE.md](/home/jbourdon/repos/social-media/docs/ARCHITECTURE.md): technical structure and module boundaries.
|
||||
- [DEVELOPMENT_WORKFLOW.md](/home/jbourdon/repos/social-media/docs/DEVELOPMENT_WORKFLOW.md): local commands and validation.
|
||||
- [PRODUCT.md](/home/jbourdon/repos/social-media/docs/PRODUCT.md): current product definition.
|
||||
- [CONVENTIONS.md](/home/jbourdon/repos/social-media/docs/CONVENTIONS.md): implementation and documentation conventions.
|
||||
|
||||
## Current Delivery Docs
|
||||
## Agentic Scaffold
|
||||
|
||||
- [use-cases/review-workflows.md](/home/jbourdon/repos/social-media/docs/use-cases/review-workflows.md): scenario-driven workflow descriptions.
|
||||
- [specs/content-approval-workflow.md](/home/jbourdon/repos/social-media/docs/specs/content-approval-workflow.md): structured feature spec for the primary workflow.
|
||||
- [specs/TEMPLATE.md](/home/jbourdon/repos/social-media/docs/specs/TEMPLATE.md): template for future feature specs.
|
||||
- [FEATURES/](/home/jbourdon/repos/social-media/docs/FEATURES): feature specs and product behavior.
|
||||
- [TASKS/](/home/jbourdon/repos/social-media/docs/TASKS): small implementation tickets for agents.
|
||||
- [PROMPTS/](/home/jbourdon/repos/social-media/docs/PROMPTS): reusable task prompts.
|
||||
- [DECISIONS/](/home/jbourdon/repos/social-media/docs/DECISIONS): decision records.
|
||||
- [FEATURE_TEMPLATE.md](/home/jbourdon/repos/social-media/docs/FEATURE_TEMPLATE.md): feature spec template.
|
||||
- [TASK_TEMPLATE.md](/home/jbourdon/repos/social-media/docs/TASK_TEMPLATE.md): task template.
|
||||
- [PROMPT_TEMPLATE.md](/home/jbourdon/repos/social-media/docs/PROMPT_TEMPLATE.md): general prompt template.
|
||||
|
||||
## Decision Records
|
||||
## Current Product Sources
|
||||
|
||||
- [decisions/README.md](/home/jbourdon/repos/social-media/docs/decisions/README.md): ADR conventions and when to add a decision record.
|
||||
- [decisions/ADR-TEMPLATE.md](/home/jbourdon/repos/social-media/docs/decisions/ADR-TEMPLATE.md): template for new architecture or product decisions.
|
||||
- [product/vision.md](/home/jbourdon/repos/social-media/docs/product/vision.md): product intent, users, scope, and priorities.
|
||||
- [product/glossary.md](/home/jbourdon/repos/social-media/docs/product/glossary.md): canonical domain vocabulary.
|
||||
- [constraints.md](/home/jbourdon/repos/social-media/docs/constraints.md): business and technical invariants.
|
||||
- [BACKLOG.md](/home/jbourdon/repos/social-media/docs/BACKLOG.md): deferred technical and product work.
|
||||
|
||||
## Archived
|
||||
|
||||
- [archive/PLAN.md](/home/jbourdon/repos/social-media/docs/archive/PLAN.md): early pivot plan; useful for historical context, but stale as an execution checklist.
|
||||
- [archive/SOCIALIZE.md](/home/jbourdon/repos/social-media/docs/archive/SOCIALIZE.md): original consolidated product brief before the docs were split into focused source-of-truth files.
|
||||
- [archive/Stripe.md](/home/jbourdon/repos/social-media/docs/archive/Stripe.md): legacy Hutopy monetization notes for memberships and tips.
|
||||
- [archive/WORKSHEET.md](/home/jbourdon/repos/social-media/docs/archive/WORKSHEET.md): historical implementation worksheet from an earlier transition phase.
|
||||
- [archive/PLAN.md](/home/jbourdon/repos/social-media/docs/archive/PLAN.md): early pivot plan.
|
||||
- [archive/SOCIALIZE.md](/home/jbourdon/repos/social-media/docs/archive/SOCIALIZE.md): original consolidated product brief.
|
||||
- [archive/Stripe.md](/home/jbourdon/repos/social-media/docs/archive/Stripe.md): legacy Hutopy monetization notes.
|
||||
- [archive/WORKSHEET.md](/home/jbourdon/repos/social-media/docs/archive/WORKSHEET.md): historical transition worksheet.
|
||||
|
||||
## Root Docs
|
||||
|
||||
- [README.md](/home/jbourdon/repos/social-media/README.md): repository overview and local development setup.
|
||||
- [AGENTS.md](/home/jbourdon/repos/social-media/AGENTS.md): working guide for coding agents. This stays at repo root intentionally.
|
||||
- [AGENTS.md](/home/jbourdon/repos/social-media/AGENTS.md): working guide for coding agents.
|
||||
|
||||
Reference in New Issue
Block a user