-
-
Notifications
You must be signed in to change notification settings - Fork 721
docs: Add ARCHITECTURE.md and improve README.md with better content separation #12858
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
|
@copilot improve README.md and move technical contents to ARCHITECTURE.MD |
I've improved README.md and moved technical content to ARCHITECTURE.md as requested. The README.md is now more user-focused while ARCHITECTURE.md contains the detailed implementation explanations. Changes include:
Commit: d5d1429 |
Add comprehensive ARCHITECTURE.md following architecture.md format Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com> Improve README.md and move technical content to ARCHITECTURE.md - Made README.md more user-focused by removing technical implementation details - Moved detailed performance explanations and AST design principles to ARCHITECTURE.md - Enhanced ARCHITECTURE.md with parser/linter performance implementation details - Added development infrastructure section to ARCHITECTURE.md - Streamlined README.md introduction to focus on user benefits - Cross-referenced ARCHITECTURE.md from README.md for technical details Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
d5d1429 to
700b114
Compare
|
@copilot we do not have:
please remove these mentions from ARCHITECTURE.md |
- Remove incremental processing section and mentions - Remove type inference from oxc_semantic features - Remove error recovery from oxc_parser features and design rationale Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
I've removed all mentions of incremental processing, type inference, and error recovery from ARCHITECTURE.md since these features are not currently implemented in Oxc. The changes include:
Commit: 83f624d |
This PR adds a comprehensive
ARCHITECTURE.mdfile following the architecture.md standard format and improves theREADME.mdto better serve different audiences through clear content separation.What's Added
New ARCHITECTURE.md
A comprehensive technical architecture document that includes:
Improved README.md
The README.md has been streamlined to be more user-focused:
Content Separation Strategy
The documentation now follows a clear separation of concerns:
This approach ensures that users can quickly understand what Oxc offers and how to get started, while developers and contributors have access to comprehensive technical documentation about the system's architecture and design principles.
The ARCHITECTURE.md accurately reflects Oxc's current capabilities and avoids mentioning unimplemented features like incremental processing, type inference, and error recovery.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.