docs: ai-generated documentation#61
Open
SteveRuble wants to merge 5 commits intoTypeFox:mainfrom
Open
Conversation
This adds a bunch of documentation, mostly generated by AI but with manual review. I used the documentation to orient myself to this codebase and iterated on it to make sure I understood how to do things, so it's been validated to some extent. Of course, I might have just misunderstood, or the AI could have gotten things wrong, it definitely needs review by people who know the codebase well.
Member
|
FYI, it might take some time until we get to this PR, everyone on the team is currently busy preparing for OCX. Thanks in advance! |
Contributor
Author
|
No worries. The PR is probably almost as useful without being merged; anyone looking around for docs will find it anyway. |
Member
|
Thanks for the contribution! It feels a bit early to document things though, as concepts are still evolving. I'd also clearly separate user documentation, which we'll eventually want to live in some website, from agent documentation, which should live in this repo but would likely be written a bit differently from user doc. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 is a bunch of documentation I had an AI generate for me as I wandered around the codebase and tried to figure things out, along with some examples I worked through to make sure I had a working understanding of how to use this tool. It probably still has some mistakes and misconceptions in it and needs refinement by someone who really knows the repository. In particular, it's missing motivations for a lot of things, where it's not clear why something is the way it is or what problem it's intended to solve. But I think it's a useful set of documents and code anyway, and could provide a decent foundation for building out the documentation more fully.
Closes #57.