Bad Links

[Derjyn]

You've got some bad links in there. Makes it a bit hard to track this complex beast, and hard to trust as well. This is all very cool stuff, but with so many wires running all over the place, having a bad link in the README makes me pause, and spend more time doing review than implementation.

[darrenhinde]

Thanks for pointing this out!

[darrenhinde]

Everything is pointing to the right links now.

Appreciate your point on that there is a lot going on, will be looking at a better way to present all the information as there is a lot of subtle things under the hood that work well together. The Blue print document describes what is happening but will need an incremental approach for different needs of complexity.

Looking at an easier way to import custom agents to new projects using commands.

[Derjyn]

Awesome! I personally appreciate the quick turnaround on that, and glad I was able to contribute a tiny bit. I'll do my best to keep my eye for any other snags. Also - thanks for not taking my tone the wrong way. Outside of being all rainbows and puppy dogs in my comments, I find it rough to not sound like a big jerk. My goal is always to be concise and mathematical and resolve the issue without all the pleasantry. The side effect there at times, is sounding like a robot with no soul!

Concerning how to map that documentation better: I've been working on a framework that implements various standards, guidelines, semantics, etc... Part of it being specific to documentation. Have you heard of the Diátaxis system? If not, first off it's not a bad system to learn and apply - it's one of those things that will follow you forever in your endeavors (versus being a one-time use burner sort of thing).

Second, you could totally feed an AI all of the documentation for your project(s), and say something to the effect of "Hey, massage my documentation into shape using the Diátaxis approach, and make it more palatable to readers. Be concise, but informative and complete in documenting everything and guiding the user on setup, usage, and off general tips."

I've applied this to great effect, and while I am a nerd and love writing documentation, as a lone wolf having to choose between writing documentation today, or developing new feature X or Y is a choice I hate having to make. Grand example of human-in-the-loop workflows with AI... I can get a bit of the joy of writing general documentation, then let an AI assistant flesh it out and make the whole of my project's documentation cohesive.

Just a thought! Sometimes I present these suggestions and think "no duh, they're probably already doing this", but on occasion I run into someone who hadn't explored that path as it's outside of their domain.

Right. Thanks again for hopping on that, and keep up the great work!

[darrenhinde]

Don't worry about tone, you took the time to give feedback and justified the reason, all seemed pretty good to me but I also have a mathematical background so could just be the no fluff is appreciated.

I have not heard of Diátaxis system... Will look into it, thanks for the suggestion.

I am currently looking at a different approach that I have used in Large Data Engineering organisations mainly around the concept of Data Governance and lineage with adjusting that approach for context engineering for storing & retrieving data.

Essentially there is a few concepts is what does the AI need to know, how much do I really need to document and how often do things need to be updated. A lot the thought comes from mistakes learnt from Cursor's embedding function and how data wasn't always great and why agents work so well right now with grep & learn from these mistakes.
I am rethinking how I document for Agents compared to Humans, I think sometimes having minimal information on certain sections is better than having a full information, refer to code files but have small concise information.

My goal is to compress information as much as possible without loosing functionality. So many studies are showing the lower the context the better the performance so that is key for a lot of this.

Appreciate the thoughtful feedback and comments. Please let me know on my next version as I am hoping makes life a bit easier for most and is easy to use & understand.