Skip to content

docs: add repository structure guide#3250

Open
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
ming1523:docs-repository-structure
Open

docs: add repository structure guide#3250
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
ming1523:docs-repository-structure

Conversation

@ming1523
Copy link
Copy Markdown

@ming1523 ming1523 commented Apr 1, 2026

Summary

  • add a standalone docs/repository-structure.md guide that maps the top-level repository layout
  • group the main workspace members so contributors can quickly find binaries, service crates, shared libraries, tests, and tooling
  • add a CONTRIBUTING.md entrypoint to the new guide for newcomers

Why

fuel-core already 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

  • verified the documented directories and workspace groupings against the current repository tree and root Cargo.toml
  • verified the new guide is linked from CONTRIBUTING.md
  • docs-only change, no runtime behavior changed

This is a docs-only change. A no-changelog path seems appropriate if maintainers agree.

@cursor
Copy link
Copy Markdown

cursor bot commented Apr 1, 2026

PR Summary

Low Risk
Docs-only changes with no impact to runtime behavior or build logic.

Overview
Adds a new docs/repository-structure.md guide that maps the repo’s top-level directories, workspace member groupings, and common starting points for contributor tasks.

Updates CONTRIBUTING.md to link newcomers to the new guide and fixes the trailing code block termination/newline at the end of the file.

Written by Cursor Bugbot for commit 86e9d29. This will update automatically on new commits. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant