首页
This commit is contained in:
zhu
127
.trellis/tasks/00-bootstrap-guidelines/prd.md
Normal file
127
.trellis/tasks/00-bootstrap-guidelines/prd.md
Normal file
@@ -0,0 +1,127 @@
|
||||
# Bootstrap Task: Fill Project Development Guidelines
|
||||
|
||||
**You (the AI) are running this task. The developer does not read this file.**
|
||||
|
||||
The developer just ran `trellis init` on this project for the first time.
|
||||
`.trellis/` now exists with empty spec scaffolding, and this bootstrap task
|
||||
exists under `.trellis/tasks/`. When they want to work on it, they should start
|
||||
this task from a session that provides Trellis session identity.
|
||||
|
||||
**Your job**: help them populate `.trellis/spec/` with the team's real
|
||||
coding conventions. Every future AI session — this project's
|
||||
`trellis-implement` and `trellis-check` sub-agents — auto-loads spec files
|
||||
listed in per-task jsonl manifests. Empty spec = sub-agents write generic
|
||||
code. Real spec = sub-agents match the team's actual patterns.
|
||||
|
||||
Don't dump instructions. Open with a short greeting, figure out if the repo
|
||||
has any existing convention docs (CLAUDE.md, .cursorrules, etc.), and drive
|
||||
the rest conversationally.
|
||||
|
||||
---
|
||||
|
||||
## Status (update the checkboxes as you complete each item)
|
||||
|
||||
- [ ] Fill frontend guidelines
|
||||
- [ ] Add code examples
|
||||
|
||||
---
|
||||
|
||||
## Spec files to populate
|
||||
|
||||
|
||||
### Frontend guidelines
|
||||
|
||||
| File | What to document |
|
||||
|------|------------------|
|
||||
| `.trellis/spec/frontend/directory-structure.md` | Component/page/hook organization |
|
||||
| `.trellis/spec/frontend/component-guidelines.md` | Component patterns, props conventions |
|
||||
| `.trellis/spec/frontend/hook-guidelines.md` | Custom hook naming, patterns |
|
||||
| `.trellis/spec/frontend/state-management.md` | State library, patterns, what goes where |
|
||||
| `.trellis/spec/frontend/type-safety.md` | TypeScript conventions, type organization |
|
||||
| `.trellis/spec/frontend/quality-guidelines.md` | Linting, testing, accessibility |
|
||||
|
||||
|
||||
### Thinking guides (already populated)
|
||||
|
||||
`.trellis/spec/guides/` contains general thinking guides pre-filled with
|
||||
best practices. Customize only if something clearly doesn't fit this project.
|
||||
|
||||
---
|
||||
|
||||
## How to fill the spec
|
||||
|
||||
### Step 1: Import from existing convention files first (preferred)
|
||||
|
||||
Search the repo for existing convention docs. If any exist, read them and
|
||||
extract the relevant rules into the matching `.trellis/spec/` files —
|
||||
usually much faster than documenting from scratch.
|
||||
|
||||
| File / Directory | Tool |
|
||||
|------|------|
|
||||
| `CLAUDE.md` / `CLAUDE.local.md` | Claude Code |
|
||||
| `AGENTS.md` | Codex / Claude Code / agent-compatible tools |
|
||||
| `.cursorrules` | Cursor |
|
||||
| `.cursor/rules/*.mdc` | Cursor (rules directory) |
|
||||
| `.windsurfrules` | Windsurf |
|
||||
| `.clinerules` | Cline |
|
||||
| `.roomodes` | Roo Code |
|
||||
| `.github/copilot-instructions.md` | GitHub Copilot |
|
||||
| `.vscode/settings.json` → `github.copilot.chat.codeGeneration.instructions` | VS Code Copilot |
|
||||
| `CONVENTIONS.md` / `.aider.conf.yml` | aider |
|
||||
| `CONTRIBUTING.md` | General project conventions |
|
||||
| `.editorconfig` | Editor formatting rules |
|
||||
|
||||
### Step 2: Analyze the codebase for anything not covered by existing docs
|
||||
|
||||
Scan real code to discover patterns. Before writing each spec file:
|
||||
- Find 2-3 real examples of each pattern in the codebase.
|
||||
- Reference real file paths (not hypothetical ones).
|
||||
- Document anti-patterns the team clearly avoids.
|
||||
|
||||
### Step 3: Document reality, not ideals
|
||||
|
||||
**Critical**: write what the code *actually does*, not what it should do.
|
||||
Sub-agents match the spec, so aspirational patterns that don't exist in the
|
||||
codebase will cause sub-agents to write code that looks out of place.
|
||||
|
||||
If the team has known tech debt, document the current state — improvement
|
||||
is a separate conversation, not a bootstrap concern.
|
||||
|
||||
---
|
||||
|
||||
## Quick explainer of the runtime (share when they ask "why do we need spec at all")
|
||||
|
||||
- Every AI coding task spawns two sub-agents: `trellis-implement` (writes
|
||||
code) and `trellis-check` (verifies quality).
|
||||
- Each task has `implement.jsonl` / `check.jsonl` manifests listing which
|
||||
spec files to load.
|
||||
- The platform hook auto-injects those spec files + the task's `prd.md`
|
||||
into every sub-agent prompt, so the sub-agent codes/reviews per team
|
||||
conventions without anyone pasting them manually.
|
||||
- Source of truth: `.trellis/spec/`. That's why filling it well now pays
|
||||
off forever.
|
||||
|
||||
---
|
||||
|
||||
## Completion
|
||||
|
||||
When the developer confirms the checklist items above are done with real
|
||||
examples (not placeholders), guide them to run:
|
||||
|
||||
```bash
|
||||
python ./.trellis/scripts/task.py finish
|
||||
python ./.trellis/scripts/task.py archive 00-bootstrap-guidelines
|
||||
```
|
||||
|
||||
After archive, every new developer who joins this project will get a
|
||||
`00-join-<slug>` onboarding task instead of this bootstrap task.
|
||||
|
||||
---
|
||||
|
||||
## Suggested opening line
|
||||
|
||||
"Welcome to Trellis! Your init just set me up to help you fill the project
|
||||
spec — a one-time setup so every future AI session follows the team's
|
||||
conventions instead of writing generic code. Before we start, do you have
|
||||
any existing convention docs (CLAUDE.md, .cursorrules, CONTRIBUTING.md,
|
||||
etc.) I can pull from, or should I scan the codebase from scratch?"
|
||||
28
.trellis/tasks/00-bootstrap-guidelines/task.json
Normal file
28
.trellis/tasks/00-bootstrap-guidelines/task.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"id": "00-bootstrap-guidelines",
|
||||
"name": "00-bootstrap-guidelines",
|
||||
"title": "Bootstrap Guidelines",
|
||||
"description": "Fill in project development guidelines for AI agents",
|
||||
"status": "in_progress",
|
||||
"dev_type": "docs",
|
||||
"scope": null,
|
||||
"package": null,
|
||||
"priority": "P1",
|
||||
"creator": "tao",
|
||||
"assignee": "tao",
|
||||
"createdAt": "2026-05-07",
|
||||
"completedAt": null,
|
||||
"branch": null,
|
||||
"base_branch": null,
|
||||
"worktree_path": null,
|
||||
"commit": null,
|
||||
"pr_url": null,
|
||||
"subtasks": [],
|
||||
"children": [],
|
||||
"parent": null,
|
||||
"relatedFiles": [
|
||||
".trellis/spec/frontend/"
|
||||
],
|
||||
"notes": "First-time setup task created by trellis init (frontend project)",
|
||||
"meta": {}
|
||||
}
|
||||
3
.trellis/tasks/05-07-rebuild-homepage/check.jsonl
Normal file
3
.trellis/tasks/05-07-rebuild-homepage/check.jsonl
Normal file
@@ -0,0 +1,3 @@
|
||||
{"_example": "Fill with {\"file\": \"<path>\", \"reason\": \"<why>\"}. Put spec/research files only — no code paths. Run `python .trellis/scripts/get_context.py --mode packages` to list available specs. Delete this line once real entries are added."}
|
||||
{"file": ".trellis\\spec\\frontend\\quality-guidelines.md", "reason": "Quality checklist for final verification."}
|
||||
{"file": ".trellis\\spec\\frontend\\index.md", "reason": "Frontend project overview for review."}
|
||||
4
.trellis/tasks/05-07-rebuild-homepage/implement.jsonl
Normal file
4
.trellis/tasks/05-07-rebuild-homepage/implement.jsonl
Normal file
@@ -0,0 +1,4 @@
|
||||
{"_example": "Fill with {\"file\": \"<path>\", \"reason\": \"<why>\"}. Put spec/research files only — no code paths. Run `python .trellis/scripts/get_context.py --mode packages` to list available specs. Delete this line once real entries are added."}
|
||||
{"file": ".trellis\\spec\\frontend\\index.md", "reason": "Frontend project overview and required stack."}
|
||||
{"file": ".trellis\\spec\\frontend\\quality-guidelines.md", "reason": "React quality and handler naming expectations."}
|
||||
{"file": ".trellis\\spec\\frontend\\component-guidelines.md", "reason": "Component naming, structure, and documentation expectations."}
|
||||
45
.trellis/tasks/05-07-rebuild-homepage/prd.md
Normal file
45
.trellis/tasks/05-07-rebuild-homepage/prd.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# Rebuild homepage from frontend prototype
|
||||
|
||||
## Goal
|
||||
|
||||
Recreate the existing `frontend` prototype homepage in the new Next.js project. The first pass only needs the UI to match the prototype homepage; navigation targets and event handlers may exist as placeholders without business logic.
|
||||
|
||||
## Source Prototype
|
||||
|
||||
- `frontend/src/app/(marketing)/page.tsx`
|
||||
- `frontend/src/app/(marketing)/layout.tsx`
|
||||
- `frontend/src/components/marketing/header.tsx`
|
||||
- `frontend/src/components/marketing/footer.tsx`
|
||||
- `frontend/src/components/marketing/reveal.tsx`
|
||||
- `frontend/src/app/globals.css`
|
||||
|
||||
## Requirements
|
||||
|
||||
- Replace the default create-next-app homepage with the StoreAI marketing homepage.
|
||||
- Preserve the prototype's visible sections:
|
||||
- Sticky marketing header.
|
||||
- Hero section with primary and secondary CTAs.
|
||||
- Stats strip.
|
||||
- Problem cards.
|
||||
- Solution cards.
|
||||
- Report preview section.
|
||||
- How-it-works steps.
|
||||
- Pricing teaser.
|
||||
- FAQ teaser.
|
||||
- Final CTA.
|
||||
- Footer.
|
||||
- Keep the implementation UI-only for now.
|
||||
- Use existing dependencies where possible; `lucide-react` is already installed in the new project.
|
||||
- Ensure the page builds in the current Next.js project.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- Do not port authentication, i18n, dashboard, billing, onboarding, API routes, or backend logic.
|
||||
- Do not implement real CTA behavior beyond normal links/placeholders.
|
||||
- Do not rewrite the whole application structure yet.
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- Visiting `/` shows the StoreAI homepage instead of the default starter page.
|
||||
- The layout, copy, icons, cards, and page rhythm visually match the prototype homepage closely.
|
||||
- The current project builds successfully with `npm run build` or the available build command.
|
||||
26
.trellis/tasks/05-07-rebuild-homepage/task.json
Normal file
26
.trellis/tasks/05-07-rebuild-homepage/task.json
Normal file
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"id": "rebuild-homepage",
|
||||
"name": "rebuild-homepage",
|
||||
"title": "Rebuild homepage from frontend prototype",
|
||||
"description": "",
|
||||
"status": "in_progress",
|
||||
"dev_type": null,
|
||||
"scope": null,
|
||||
"package": null,
|
||||
"priority": "P2",
|
||||
"creator": "tao",
|
||||
"assignee": "tao",
|
||||
"createdAt": "2026-05-07",
|
||||
"completedAt": null,
|
||||
"branch": null,
|
||||
"base_branch": "master",
|
||||
"worktree_path": null,
|
||||
"commit": null,
|
||||
"pr_url": null,
|
||||
"subtasks": [],
|
||||
"children": [],
|
||||
"parent": null,
|
||||
"relatedFiles": [],
|
||||
"notes": "",
|
||||
"meta": {}
|
||||
}
|
||||
Reference in New Issue
Block a user