Krystie
7b626f8653
doc/triangles-cli.md is a new operator-facing guide covering:
- Where triangles-cli looks for triangles.conf (the resolution
chain: -conf absolute path > <datadir>/triangles.conf > cwd)
- The four common ops shapes (default datadir, custom datadir,
custom datadir+conf, multi-node on one host)
- Default per-platform data directories (Linux/macOS/Windows)
- Common operations (chain state, wallet, staking, snapshots)
- Output formats (-raw, -getinfo, JSON piping with jq)
- The 'tri' friendly wrapper from scripts/tri/
- Cross-host operation via SSH tunnel
- Common pitfalls (the misleading 'missing RPC credentials'
error, daemon not running, testnet port mismatch, multi-node
port conflict)
- Full flag reference
doc/README.md converted from a stub to a proper doc index linking
operator + developer + misc docs.
README.md gets a one-paragraph link + quick-start example at the
top of the 'RPC Commands' section.
No code change. Documentation only.
Adversarial check (in-line, docs-only):
- All CLI flags cross-checked against the in-source help text
in src/triangles-cli.cpp:541-551.
- Default datadir paths cross-checked against
src/triangles-cli.cpp:146-167.
- RPC port defaults (19111 mainnet, 19112 testnet) cross-checked
against src/triangles-cli.cpp:223.
- Conf resolution precedence cross-checked against
src/triangles-cli.cpp:169-176.
- Conf-example cross-link target verified at
contrib/triangles.conf.example.
- Wallet backup command verified against RPC list.
- No new commands documented; no flags invented.
1.3 KiB
1.3 KiB
Triangles Documentation
Cryptographic Triangles (TRI) is a privacy-focused proof-of-stake cryptocurrency derived from Bitcoin, with Tor v3 hidden services mandatory and a 120-second block time. This directory holds operator- and developer-facing documentation.
Operator docs
- triangles-cli.md — operating the JSON-RPC CLI against one or more daemon instances, including custom data-dir setups, common operations, and the full flag reference.
- release-process.md — how a release is cut, signed, and published.
Developer docs
- build-unix.txt — building on Linux.
- build-osx.txt — building on macOS.
- build-msw.txt — building on Windows.
- coding.txt — coding style and conventions.
- translation_process.md — how translations are managed.
- embedded-tor-rebase.md — bumping the embedded Tor submodule.
- i2p.md — I2P integration notes.
Misc
- README_windows.txt — Windows README (legacy, predates the markdown docs).
- assets-attribution.txt — third-party asset attributions.
- Doxyfile — Doxygen configuration for source documentation.