diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..0dc05d80802 --- /dev/null +++ b/docs/README.md @@ -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