Added More Docs #2959
Open
Added More Docs #2959
Conversation
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
|
I don't think we can reasonably accept automatically generated documentation, especially if it's generated by non-deterministic LLMs with a tool that isn't publicly available. As a sidenote, it's a bit overkill with the diagrams, and there are some inaccuracies when describing how the compiler works. In any case, it's hard to view this PR as credible when it's part of what I'm tempted to describe as a small-scale spam campaign aiming to advertise your product... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds source-linked, auto-generated docs for the codebase. Before you dismiss it: it includes inline source references, architecture diagrams, and I think it does a solid job. No hard feelings if you’d prefer not to include it.
If you find it useful, I’m building a documentation copilot to help explain why code is the way it is. It will:
I'm just building this out and would love to chat about what would help most so I can build something genuinely useful.
docforge.net