[Suggestion]Source References

[tzengshinfu]

Hi, folks:

Would it improve the user experience if documents had source code location indexes, and even if there were location indexes between documents?
(as shown in the images below).

The index between document and source code.

The index between document and document.

[TabishB]

@tzengshinfu Yeah I think it's interesting as a concept and something I've considered. I'll have to test it out to see how it works/feels in practice.

Are you finding that the agent is good at adding details like this? Or is this just an idea for now?

[tzengshinfu]

@TabishB It's just an idea. The inspiration comes from the fact that project source code and specification documentation feel like a collection of knowledge, similar to Wikipedia.

They all have an entry point, and readers(developers) find the parts they're interested in. These parts are interconnected, and their authenticity is verified by the underlying 'Source'.

Whether the 'Spec' in the document matches its description is verified by the source code, and the functionality of the source code is verified by testing. So, if we could drill down layer by layer like a Wiki during the review, with each mentioned function having a corresponding 'Source', that should be great.