Fix documentation inconsistencies and clarify IPFS/IPNS relay architecture

[Copilot]

Addresses 10 review feedback items from PR #4 regarding version inconsistencies, missing API details, and architectural clarity around the IPFS/IPNS relay model.

Changes

Version Alignment

• Synchronized all documentation files to version 1.8.2 (was: 1.7.1-1.8.2)
• Fixed missing YAML frontmatter delimiter in API_SPECIFICATION.md

IPFS/IPNS Relay Clarifications

• Added BASE64 encoding step to IPNS publishing sequence diagram
• Fixed IpfsModule.publishIpnsRecord interface signature: Uint8Array → base64IpnsRecord: string
• Clarified backend stores encrypted root folder key (not IPNS key directly); IPNS keypairs stored encrypted in folder metadata

Documentation Quality

• Enhanced PoC warning with callout format to prevent production misuse
• Expanded database table description to list all 6 tables explicitly

Example Interface Change

// Before
publishIpnsRecord(record: Uint8Array, ipnsName: string, ...): Promise<void>;

// After
publishIpnsRecord(base64IpnsRecord: string, ipnsName: string, ...): Promise<void>;
// Matches API spec: POST /ipns/publish expects BASE64-encoded signed record

Sequence Diagram Enhancement

C->>C: Sign IPNS record (Ed25519)
C->>C: Encode signed record to BASE64          # Added
C->>B: POST /ipns/publish (BASE64-encoded signed record)

Loading

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.