Last active
March 1, 2025 01:14
-
-
Save benzmuircroft/a8977e6231a7f1c438b7b8d254740d9d to your computer and use it in GitHub Desktop.
Breadcrumb comments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Comment Format for Task Tracking | |
| Each task is marked with # 🆔TASK-NAME, followed by a flow reference showing: | |
| 🔝 Origin location (role + file path) | |
| 🔙 Previous step (role + file path) | |
| 🔜 Next step (role + file path) | |
| Example Implementation | |
| # 🆔login 🔝👷/src/auth/login.js 🔙🌱/src/app/init.js 🔜🪙/src/service/auth.js | |
| # 🆔logout 🔝🌱/src/app/sessions.js 🔙👷/src/auth/logout.js 🔜🪙/src/service/sessions.js | |
| # 🆔chat-message 🔝🪙/src/service/chatRelay.js 🔙🌱/src/app/chatRouter.js 🔜👷/src/chat/sendMessage.js | |
| Key Benefits | |
| ✅ Easy to search → Just look for # 🆔TASK-NAME | |
| ✅ Visually structured → Roles and flow are clear | |
| ✅ Minimal yet powerful → No unnecessary clutter | |
| ✅ Future-proof → Adapts to changes in code | |
| 🚀 This system is clean, intuitive, and ready to use! |
The ratchet
tool has extended functionality (it bends as modes and accepts various bits)
bits would be sub modules (plug-n-play to other modules or handling for use-cases or data-types)
then how to recipes and document the input/output + methods
basically there should be no gaps in standing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Module Recipe Usage comments todo: next