Skip to content

docs: add repository-local documentation index #3245

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.

Sign up for GitHub

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

Open
ming1523 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add repository-local documentation index #3245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Fuel Core Documentation

This directory contains repository-local documentation for developing, debugging, and understanding `fuel-core`.

## Start Here

- [Architecture](architecture.md): high-level overview of the Fuel client architecture and service boundaries
- [Developer debugging guide](developers/debugging.md): local build, run, and IDE debugging workflows
- [Fee calculations](fee_calculations.md): notes on how fees are derived in the client
- [PoA docs](poa/): Proof-of-Authority flows, failover notes, and formal artifacts

## Related Resources

- [Contribution guide](../CONTRIBUTING.md): contribution workflow, changelog requirements, and issue linking
- [Deployment overview](../deployment/README.md): Docker-related files in this repository
- [Fuel node operator docs](https://docs.fuel.network/docs/node-operator/): running Fuel nodes outside local development