Skip to content

Commit 4d1752d

Browse files
author
Ramesh Tamilselvan
committed
docs: add comprehensive documentation and fix docs links
- Add docs/README.md index with navigation to all sections - Add docs/api/README.md with full API reference (15 route modules) - Add docs/architecture/README.md with system design and data flow - Add docs/contracts/README.md with all 25 contracts documented - Add docs/compliance/README.md with ADGM/ITMO/KYC framework - Update README.md links to point to GitHub repo docs
1 parent f593fd9 commit 4d1752d

6 files changed

Lines changed: 1381 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
<img src="https://img.shields.io/badge/React-19-61DAFB?style=flat-square&logo=react&logoColor=white" alt="React">
1616
</p>
1717
<p>
18-
<a href="https://terraqura.aethelred.io">App</a> &middot;
19-
<a href="https://docs.aethelred.io">Docs</a> &middot;
20-
<a href="https://api.terraqura.aethelred.io/docs">API Reference</a> &middot;
18+
<a href="https://app.terraqura.com">App</a> &middot;
19+
<a href="https://github.com/aethelred-foundation/terraqura/tree/main/docs">Docs</a> &middot;
20+
<a href="https://github.com/aethelred-foundation/terraqura/tree/main/docs/api">API Reference</a> &middot;
2121
<a href="https://discord.gg/aethelred">Discord</a>
2222
</p>
2323
</div>
@@ -333,7 +333,7 @@ All contracts target the Aethelred L1 EVM and are written in Solidity 0.8.28 wit
333333
</tr>
334334
</table>
335335

336-
Full reference: [api.terraqura.aethelred.io/docs](https://api.terraqura.aethelred.io/docs)
336+
Full reference: [docs/api](https://github.com/aethelred-foundation/terraqura/tree/main/docs/api)
337337

338338
---
339339

@@ -464,8 +464,8 @@ Apache 2.0 &mdash; see [LICENSE](LICENSE) for details.
464464
---
465465

466466
<p align="center">
467-
<a href="https://terraqura.aethelred.io">App</a> &middot;
468-
<a href="https://docs.aethelred.io">Docs</a> &middot;
467+
<a href="https://app.terraqura.com">App</a> &middot;
468+
<a href="https://github.com/aethelred-foundation/terraqura/tree/main/docs">Docs</a> &middot;
469469
<a href="https://discord.gg/aethelred">Discord</a> &middot;
470470
<a href="https://twitter.com/aethelred">Twitter</a> &middot;
471471
<a href="mailto:support@aethelred.io">Support</a>

docs/README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# TerraQura Documentation
2+
3+
> Institutional-Grade Carbon Asset Platform with Proof-of-Physics Verification on the Aethelred Network.
4+
5+
---
6+
7+
## Quick Navigation
8+
9+
| Section | Description | Link |
10+
|---------|-------------|------|
11+
| Architecture | System design, data flow, monorepo structure | [architecture/](architecture/) |
12+
| API Reference | REST API endpoints, authentication, webhooks | [api/](api/) |
13+
| Smart Contracts | 25 Solidity contracts, roles, upgrade process | [contracts/](contracts/) |
14+
| Compliance | ADGM, ITMO/Article 6, KYC tiers, data residency | [compliance/](compliance/) |
15+
| Disaster Recovery | RTO/RPO targets, failover procedures | [DISASTER_RECOVERY.md](DISASTER_RECOVERY.md) |
16+
| Gas Optimization | Contract gas benchmarks and optimization notes | [GAS_OPTIMIZATION_REVIEW.md](GAS_OPTIMIZATION_REVIEW.md) |
17+
18+
---
19+
20+
## Overview
21+
22+
TerraQura is a full-stack, institutional-grade carbon credit platform built on **Aethelred** -- a sovereign Layer 1 EVM chain optimised for verifiable AI computation. The platform enables the complete carbon credit lifecycle:
23+
24+
1. **Capture** -- Direct Air Capture (DAC) units report real-time telemetry via the NativeIoT Oracle.
25+
2. **Verify** -- A 3-phase Proof-of-Physics pipeline (source check, logic check, mint check) validates sensor data against on-chain thresholds.
26+
3. **Mint** -- Verified capture periods produce ERC-1155 carbon credits with immutable provenance metadata stored on IPFS/Arweave.
27+
4. **Trade** -- Credits are traded on a P2P marketplace with batch auctions, AMM liquidity pools, fractional credit support, and gasless meta-transactions.
28+
5. **Retire** -- Credits are permanently retired on-chain, producing retirement certificates linked to the ITMO registry for Article 6 compliance.
29+
30+
---
31+
32+
## Platform Status
33+
34+
| Metric | Value |
35+
|--------|-------|
36+
| Smart contracts | 25 (Solidity 0.8.28, UUPS upgradeable) |
37+
| Test coverage | 881+ tests passing across all layers |
38+
| Dashboard pages | 8 operational |
39+
| Deployment target | Aethelred Testnet (pre-mainnet) |
40+
| License | Apache 2.0 |
41+
42+
---
43+
44+
## Repository Structure
45+
46+
```
47+
terraqura/
48+
apps/
49+
api/ Fastify REST API (TypeScript)
50+
web/ Next.js 16 frontend (React 19)
51+
contracts/ Solidity smart contracts (Hardhat)
52+
worker/ BullMQ background job workers
53+
docs/ Docusaurus documentation site
54+
analytics/ Python analytics service
55+
verifier/ Rust verification service
56+
indexer/ Go blockchain indexer
57+
packages/
58+
config/ Shared ESLint and TypeScript configs
59+
contract-types/ Generated TypeChain typings
60+
database/ Drizzle ORM schema and migrations
61+
monitoring/ Prometheus metrics and alerting
62+
queue/ BullMQ queue definitions
63+
sdk/ Client SDK
64+
subgraph/ The Graph subgraph definitions
65+
types/ Shared TypeScript type definitions
66+
infrastructure/ Docker, Kubernetes, CI/CD manifests
67+
docs/ Project documentation (this directory)
68+
```
69+
70+
---
71+
72+
## Getting Started
73+
74+
Refer to the root [README](../README.md) for quick-start instructions, environment setup, and development workflow.
75+
76+
---
77+
78+
## Contributing
79+
80+
See [CONTRIBUTING.md](../CONTRIBUTING.md) for contribution guidelines, branch naming conventions, and pull request requirements.
81+
82+
---
83+
84+
## Security
85+
86+
For security reports and the responsible disclosure policy, see [SECURITY.md](../SECURITY.md).

0 commit comments

Comments
 (0)