docs: AGENTS.md and core architecture documentation#18
Open
tunahorse wants to merge 1 commit intodanwritecode:masterfrom
Open
docs: AGENTS.md and core architecture documentation#18tunahorse wants to merge 1 commit intodanwritecode:masterfrom
tunahorse wants to merge 1 commit intodanwritecode:masterfrom
Conversation
Owner
|
I'd like to move to an idiomatic solution to this using doc comments and inner doc comments: https://doc.rust-lang.org/rustdoc/index.html#outer-and-inner-documentation We should utilize inner doc comments and then link to deeper docs if necessary in the docs dir. However i'd like to try to collapse everything into the lib.rs file where we can dump the inner doc comments and leave behind the docs dir entirely. i don't think it's that complex to warrant all of those pages. Lets reduce the verbosity of those docs too by like 50%, hit the high level shit and people can read the source code for the rest. I don't want to put into english the source code. From opus: |
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
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.
Summary
Files