chore: Cleanup docs.#73
Merged
Merged
Conversation
|
Review changes with |
There was a problem hiding this comment.
Pull request overview
This pull request performs a comprehensive documentation cleanup and reorganization, removing obsolete and external reference documentation while consolidating and enhancing core architectural documentation.
Changes:
- Removed task tracking documents (memory-length-tracking-mstore.md) that appear completed or obsolete
- Migrated libpolly.md content into formal ADR-003
- Consolidated jet-description.md content into architecture.md (history, MEV use case sections)
- Removed all external EVM reference documentation (.mdx files) - these appear to be copied from evm.codes
- Removed architecture-refactoring-summary.md (superseded by current architecture docs)
- Removed TREE.md (directory listing that becomes stale)
- Added comprehensive manifesto.md documenting engineering philosophy and patterns
- Enhanced architecture.md with historical context, use cases, and detailed file-by-file summaries
Reviewed changes
Copilot reviewed 181 out of 182 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tasks/memory-length-tracking-mstore.md | Removed task tracking document (appears completed or obsolete) |
| docs/libpolly.md | Content migrated to formal ADR-003 |
| docs/jet-description.md | Content consolidated into architecture.md |
| docs/ext/evm/*.mdx | Removed 100+ external EVM reference files (likely from evm.codes) |
| docs/architecture-refactoring-summary.md | Removed, superseded by current architecture docs |
| docs/TREE.md | Removed directory tree listing (becomes stale) |
| docs/architecture/manifesto.md | New comprehensive engineering philosophy document (336 lines) |
| docs/architecture/architecture.md | Enhanced with history, MEV motivation, file summaries |
| docs/adrs/adr-003.md | New ADR documenting libpolly decision |
Summary of ChangesHello @tcrypt25519, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly refactors the project's documentation, aiming for improved clarity, accuracy, and maintainability. It centralizes critical architectural details, introduces foundational guiding principles, and prunes extraneous or superseded files. The changes ensure that the documentation better reflects the current state and future direction of the project, providing a more coherent and accessible resource for developers. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides a significant and valuable cleanup of the project's documentation. It removes many outdated or scattered files and consolidates the architectural information into a few key documents, notably architecture.md and the new manifesto.md. This greatly improves the structure and accessibility of the documentation.
My review includes a couple of suggestions to ensure that no valuable technical details are lost during this refactoring. Specifically, I've pointed out that some detailed information about runtime function bindings and struct layout mismatches, which were present in the removed documents, would be beneficial to preserve in the new documentation.
We ended up reinstalling it.
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.
No description provided.