Ty_Tech/ai-business-ideas
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated root README.md to reflect that idea files are now named README.md (not IDEA.md) so they appear at the folder root. Also updated all references in instructions and maintenance notes.

Browse Source
This commit is contained in:
Ty
2026-06-18 17:54:04 +00:00
parent b03238c508
commit ff352f8f68
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -6
View File
@@ -11,7 +11,7 @@ When a user says **"capture a new idea"** or **"add idea"**, you (the AI) **MUST
### Phase 1 — Initialize ### Phase 1 — Initialize
1. Ask the user for a **slug** (kebab-case folder name, e.g., `ai-first-ebay-cataloging-assistant`). 1. Ask the user for a **slug** (kebab-case folder name, e.g., `ai-first-ebay-cataloging-assistant`).
2. Create the folder: `ideas/<slug>/` 2. Create the folder: `ideas/<slug>/`
3. Copy `TEMPLATE.md` → `ideas/<slug>/IDEA.md` as the working draft. 3. Copy `TEMPLATE.md` → `ideas/<slug>/README.md` as the working draft.
### Phase 2 — Guided Capture (One Section at a Time) ### Phase 2 — Guided Capture (One Section at a Time)
For **each section** in the template, in order: For **each section** in the template, in order:
@@ -37,9 +37,9 @@ For **each section** in the template, in order:
### Phase 3 — Finalize & Save ### Phase 3 — Finalize & Save
1. **Validate:** Every section has meaningful content (no "TBD", "—", or empty bullets). 1. **Validate:** Every section has meaningful content (no "TBD", "—", or empty bullets).
2. Write the completed `IDEA.md` to `ideas/<slug>/IDEA.md`. 2. Write the completed `README.md` to `ideas/<slug>/README.md`.
3. **Update the Sitemap below** (add/update row in the table). 3. **Update the Sitemap below** (add/update row in the table).
4. Confirm to the user: *"Idea saved at `ideas/<slug>/IDEA.md` with state `<state>` and sitemap updated."* 4. Confirm to the user: *"Idea saved at `ideas/<slug>/README.md` with state `<state>` and sitemap updated."*
> **Save gate:** All 10 sections populated → save allowed at any valid state. No section left blank. > **Save gate:** All 10 sections populated → save allowed at any valid state. No section left blank.
@@ -63,9 +63,11 @@ ai-business-ideas/
├── TEMPLATE.md ← Master template (source of truth for structure) ├── TEMPLATE.md ← Master template (source of truth for structure)
└── ideas/ └── ideas/
└── <slug>/ ← One folder per idea └── <slug>/ ← One folder per idea
└── IDEA.md ← Populated template for that idea └── README.md ← Populated template for that idea (shown at folder root)
``` ```
> **Note on file naming:** Inside each idea folder, the file is named `README.md` (not `IDEA.md`). This allows the idea content to appear directly when viewing the folder on Gitea without an extra click.
--- ---
## 📋 Template Reference ## 📋 Template Reference
@@ -77,10 +79,10 @@ See [`TEMPLATE.md`](TEMPLATE.md) for the full section definitions, examples, and
## 🔧 Maintenance Notes ## 🔧 Maintenance Notes
- **Adding an idea:** Follow the AI instructions above — the AI handles folder creation, guided capture, validation, and sitemap update. - **Adding an idea:** Follow the AI instructions above — the AI handles folder creation, guided capture, validation, and sitemap update.
- **Editing an idea:** The AI re-runs guided capture for only the sections you want to change, then updates `IDEA.md` and the sitemap `Last Updated` column. - **Editing an idea:** The AI re-runs guided capture for only the sections you want to change, then updates `README.md` and the sitemap `Last Updated` column.
- **State transitions:** Change `State of This Idea` between `initial` → `in progress` → `ready for review` as work progresses. The sitemap `State` column reflects the current value. - **State transitions:** Change `State of This Idea` between `initial` → `in progress` → `ready for review` as work progresses. The sitemap `State` column reflects the current value.
- **Archiving:** Change state to `archived` (not in template but supported) — the sitemap row stays, status reflects it. - **Archiving:** Change state to `archived` (not in template but supported) — the sitemap row stays, status reflects it.
- **Sitemap sync:** If the sitemap ever drifts, the AI can regenerate it by scanning all `ideas/*/IDEA.md` files and reading their `State of This Idea` and top metadata. - **Sitemap sync:** If the sitemap ever drifts, the AI can regenerate it by scanning all `ideas/*/README.md` files and reading their `State of This Idea` and top metadata.
--- ---