Create Hackbot docs - #6589
Open
evgenyrp wants to merge 1 commit into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I tried to make them human-readable, concise, structured, and deduplicated.
The goal is to be able to look at a doc for a specific part of Hackbot to understand how it works faster. Another goal is to maintain those together with the code, which is essentially free now with AI, and help with reviewing PRs, as the change in the docs will often describe the code changes and how they fit the overall architecture.
We still have a couple of readme files on Hackbot outside of the
/docs, but maybe it's better to leave them there for discoverability until we set up a documentation website.fixes #6578