diff --git a/Design_Doc/Tech_Desc.md b/Design_Doc/Tech_Desc.md index fb9a317..a6dfe3a 100644 --- a/Design_Doc/Tech_Desc.md +++ b/Design_Doc/Tech_Desc.md @@ -472,6 +472,14 @@ test_full_deployment() { ## Design +- Rename `Design_Doc/instructions.md` to `Design_Doc/instructions2AI.md`, this document file is for input instructions for AI. The content should be same for all different projects, so all projects reference to this scaffold should copy this `Design_Doc/instructions2AI.md` same content to their own project. Update the corresponding document, such as: `Design_Doc/README.md`. + - Result + 1. ✅ Renamed Design_Doc/instructions.md → Design_Doc/instructions2AI.md + 2. ✅ Updated README.md to include instructions2AI.md in the documentation table with a description + + The document is now ready for AI assistants to reference, and all projects using this scaffold should copy the + same instructions2AI.md content. + - I have the following reference project(s) i built before, you go to find the common structure including the folder(s) structure and file(s) with their content except the content as for corresponding project only. These deployment scripts are for auto. deployment application with docker by bash script. - You can read the public sites: - [rvs-prxy](https://app.radicle.xyz/nodes/ash.radicle.garden/rad%3Az3ASs6eodxMzh17pJv4NFbNWELhas) diff --git a/Design_Doc/instructions.md b/Design_Doc/instructions.md index dadda7c..81ecd96 100644 --- a/Design_Doc/instructions.md +++ b/Design_Doc/instructions.md @@ -4,6 +4,7 @@ # Your Current Tasks - Listing the specific tasks for this session. + # Quick Reminder: Update the Documents After You Change the Code Whenever you finish making code changes, please take a few minutes to update the related documents. diff --git a/Design_Doc/instructions2AI.md b/Design_Doc/instructions2AI.md new file mode 100644 index 0000000..dadda7c --- /dev/null +++ b/Design_Doc/instructions2AI.md @@ -0,0 +1,62 @@ +# Before Starting Any Work +- Please read the following documents carefully **before taking any actions** on this project: `README.md`, `Design_Doc/Spec.md`, `Design_Doc/Operations.md` and `Design_Doc/Tech_Desc.md`. You may skip the `Design_Doc/Tech_Desc.md` -> "AI Prompt" section and its sub-sections when reading. These files provide essential background information and project understanding. Only after reviewing them should you proceed with the following tasks. + +# Your Current Tasks +- Listing the specific tasks for this session. + +# Quick Reminder: Update the Documents After You Change the Code + +Whenever you finish making code changes, please take a few minutes to update the related documents. +This keeps everything clear and up-to-date for everyone on the team. + +## Which files might need an update? +Only touch the files that your changes actually affect. The most common ones are: + +- `README.md` +- `Design_Doc/Spec.md` +- `Design_Doc/Operations.md` +- `Design_Doc/Tech_Desc.md` + +## How should you update them? +Just follow the style and purpose each file already has. +(You can check the "Documentation Overview" part in `README.md` if you're not sure.) + +--- + +## ⚠️ CRITICAL RULE for `Design_Doc/Tech_Desc.md` - The "AI Prompt" Section + +**The "AI Prompt" section at the end of `Design_Doc/Tech_Desc.md` must NEVER be modified, deleted, or rewritten by you.** + +### What is the "AI Prompt" section? +- It is the section that starts with `# AI Prompt` (level-1 heading) +- It is always located at the **very end** of `Design_Doc/Tech_Desc.md` +- It contains sub-sections like `## AI Prompt habit as a reminder`, `## Script Code`, `## Doc.` +- It contains **task history and instructions from previous sessions** written by the user + +### Why must you NOT touch it? +- This section is **written and maintained by the user only** +- It contains **accumulated task history** that the user wants to preserve +- It is **not documentation** about the project - it is a **working log of tasks** +- Other team members (including the user) will update this section manually when needed + +### What you MUST do: +✅ **Leave the "AI Prompt" section completely unchanged** +✅ **Keep the exact content** that is currently there (do not revert, do not update, do not clean up) +✅ **Only edit the technical documentation sections** that come BEFORE the "AI Prompt" section +✅ **Ensure "AI Prompt" stays at the end** of the file (do not move it) + +### What you MUST NOT do: +❌ **Do NOT delete** the "AI Prompt" section +❌ **Do NOT modify** any words, sentences, or formatting inside "AI Prompt" +❌ **Do NOT revert** it to an older version +❌ **Do NOT clean up** or reorganize its content +❌ **Do NOT add** new task results to it (the user does this manually) +❌ **Do NOT remove** task history from it + +### Simple rule to remember: +> **Everything before `# AI Prompt` = Your responsibility to update** +> **Everything from `# AI Prompt` to the end = User's responsibility, DO NOT TOUCH** + +--- + +Thank you so much for helping keep the documents accurate and the task history preserved — it makes a big difference to the whole team! diff --git a/README.md b/README.md index 1a907bb..747b92b 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,11 @@ This document (README.md) keeps things simple and gives you the big picture. It Use this document to understand what the project does and find the right guide for your needs. -For more details, we have three guides for different needs: +For more details, we have the following documents: | Document | What's Inside | Who It's For | |----------|---------------|--------------| +| **[instructions2AI.md](Design_Doc/instructions2AI.md)** | AI assistant instructions and task guidelines | AI assistants working on this project | | **[Operations Guide](Design_Doc/Operations.md)** | Step-by-step setup instructions, what to expect, common questions | Everyone — start here! | | **[Specifications](Design_Doc/Spec.md)** | What this tool does, what you get, what makes it special | Users who want to understand features | | **[Technical Description](Design_Doc/Tech_Desc.md)** | How it works inside, code structure, technical details | Developers and technical team |