Update docs/DEV.md
This commit is contained in:
parent
01a04fa061
commit
1bd85a051d
19
docs/DEV.md
19
docs/DEV.md
|
|
@ -108,7 +108,7 @@ Typical uses:
|
||||||
- inspect transaction fields
|
- inspect transaction fields
|
||||||
- apply or undo balance-sheet effects
|
- apply or undo balance-sheet effects
|
||||||
|
|
||||||
For user-facing transaction behavior, see [TRANSACTIONS.md](src/branch/main/docs/TRANSACTIONS.md).
|
For user-facing transaction behavior, see the transaction-specific guides linked from [README.md](../README.md).
|
||||||
|
|
||||||
### Common Hashing and Types
|
### Common Hashing and Types
|
||||||
|
|
||||||
|
|
@ -148,7 +148,7 @@ Typical uses:
|
||||||
- inspect client request helpers
|
- inspect client request helpers
|
||||||
- inspect response structures
|
- inspect response structures
|
||||||
|
|
||||||
For raw client handshake notes, see [DEV_CLIENTS.md](src/branch/main/docs/DEV_CLIENTS.md).
|
For raw client handshake notes, see [DEV_CLIENTS.md](DEV_CLIENTS.md).
|
||||||
|
|
||||||
### Standalone Tool Connections
|
### Standalone Tool Connections
|
||||||
|
|
||||||
|
|
@ -225,7 +225,7 @@ When adding a tool:
|
||||||
- use `standalone_tools::connections` for RPC client requests
|
- use `standalone_tools::connections` for RPC client requests
|
||||||
- keep RPC payloads binary across the TCP stream
|
- keep RPC payloads binary across the TCP stream
|
||||||
- print human-readable or JSON-decoded output only after the binary response is received
|
- print human-readable or JSON-decoded output only after the binary response is received
|
||||||
- add the tool to [CLI_TOOLS.md](src/branch/main/docs/CLI_TOOLS.md)
|
- add the tool to the matching user-facing guide linked from [README.md](../README.md)
|
||||||
|
|
||||||
## Adding New RPC Commands
|
## Adding New RPC Commands
|
||||||
|
|
||||||
|
|
@ -242,9 +242,10 @@ When adding a command:
|
||||||
|
|
||||||
## Documentation Map
|
## Documentation Map
|
||||||
|
|
||||||
- [README.md](src/branch/main/README.md): build, configure and start a node
|
- [README.md](../README.md): build, configure and start a node
|
||||||
- [CLI_TOOLS.md](src/branch/main/docs/CLI_TOOLS.md): command-line tool reference
|
- [WALLET_TOOLS.md](WALLET_TOOLS.md): wallet command reference
|
||||||
- [TRANSACTIONS.md](src/branch/main/docs/TRANSACTIONS.md): transaction behavior reference
|
- [VALIDATION_TOOLS.md](VALIDATION_TOOLS.md): validation command reference
|
||||||
- [POSTGRES.md](src/branch/main/docs/POSTGRES.md): manual PostgreSQL setup
|
- [BLOCKS_AND_TRANSACTIONS.md](BLOCKS_AND_TRANSACTIONS.md): block and transaction lookup reference
|
||||||
- [SETTINGS.md](src/branch/main/docs/SETTINGS.md): `settings.ini` field reference
|
- [POSTGRES.md](POSTGRES.md): manual PostgreSQL setup
|
||||||
- [DEV_CLIENTS.md](src/branch/main/docs/DEV_CLIENTS.md): low-level client handshake and request notes
|
- [SETTINGS.md](SETTINGS.md): `settings.ini` field reference
|
||||||
|
- [DEV_CLIENTS.md](DEV_CLIENTS.md): low-level client handshake and request notes
|
||||||
Loading…
Reference in New Issue