Documentation Index
Fetch the complete documentation index at: https://docs.specterpq.com/llms.txt
Use this file to discover all available pages before exploring further.
This docs site is maintained separately from the main product repo.The verification sources below point to the product repository at pranshurastogi/SPECTER.
Why this page exists
Use this page when you need to answer one question precisely: Is this statement documented because it is implemented today, or because it is planned? The matrix below maps the major public docs claims to source files and, where relevant, to the GitHub issues that track known gaps.Core protocol and API
| Docs claim | Verification source | Notes |
|---|---|---|
The backend exposes /health, key generation, stealth, ENS, SuiNS, IPFS, registry, and Yellow routes | specter-api/src/routes.rs | Use this file as the route-level source of truth for API availability. |
POST /api/v1/keys/generate returns long-term spending and viewing keys plus a meta_address | specter-api/src/handlers.rs, specter-api/src/dto.rs | This is current behavior. Client-side key generation is tracked in issue #18. |
POST /api/v1/stealth/create returns Ethereum and Sui stealth destinations plus announcement data | specter-api/src/handlers.rs, specter-api/src/dto.rs | The response includes stealth_address, stealth_sui_address, ephemeral_ciphertext, and view_tag. |
POST /api/v1/stealth/scan returns recovered discoveries including secret material | specter-api/src/handlers.rs, specter-api/src/dto.rs | The docs must continue to warn that stealth_sk and eth_private_key are sensitive outputs. |
| ENS and SuiNS name resolution are first-class API features | specter-api/src/routes.rs, specter-ens/, specter-suins/ | Public docs can describe both as implemented resolution paths. |
| Yellow endpoints exist in the API surface | specter-api/src/routes.rs, specter-api/src/handlers.rs | The existence of routes is verified separately from production completeness. |
Security, storage, and operations
| Docs claim | Verification source | Notes |
|---|---|---|
| The API includes auth, CORS, rate limiting, and security headers middleware | specter-api/src/middleware.rs, specter-api/src/state.rs | Docs should continue to note that POST endpoints are unprotected if API_KEY is not configured. |
| The registry backend can run in memory or Turso | specter-api/src/state.rs, specter-registry/ | Public docs should treat memory as development mode and Turso as the current durable backend. |
| Announcement discovery is backend-managed today | specter-api/src/handlers.rs, specter-registry/ | Backend-independent recovery is not implemented yet. Track issue #16. |
| The repo has an open hardening backlog for release process and production readiness | Issue #19, Issue #17 | Use these issues when docs need to describe current limitations instead of future guarantees. |
Yellow integration status
| Docs claim | Verification source | Notes |
|---|---|---|
| Channel create and discover flows are implemented as API handlers | specter-api/src/handlers.rs, specter-yellow/ | Public docs can describe these as current features. |
| Funding and close responses still include placeholder-style behavior | specter-api/src/dto.rs, api/yellow.mdx | Keep the docs explicit about partial behavior here. Do not present settlement as fully automated if it is not. |
How to update docs safely
When the product repo changes:- Verify the behavior in source first.
- Update the relevant guide or reference page.
- Update this matrix if the source of truth moved or the implementation status changed.
- Move future-only items to Roadmap instead of blending them into implementation docs.
Related pages
- Contribution Opportunities for the live GitHub backlog
- Contributing for workflow and repo boundaries
- Roadmap for planned work that should not be described as shipped