docs: add repository structure guide#3250
Open
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
Open
Conversation
PR SummaryLow Risk Overview Updates Written by Cursor Bugbot for commit 86e9d29. This will update automatically on new commits. Configure here. |
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
docs/repository-structure.mdguide that maps the top-level repository layoutCONTRIBUTING.mdentrypoint to the new guide for newcomersWhy
fuel-corealready has substantial contributor documentation, but it does not yet provide a single repository-level map for people trying to understand where to start. A lightweight structure guide makes the codebase easier to approach without changing runtime behavior or duplicating implementation details.Validation
Cargo.tomlCONTRIBUTING.mdThis is a docs-only change. A no-changelog path seems appropriate if maintainers agree.