docs: rewrite README and add PRODUCT, ARCHITECTURE, ROADMAP, TODO per governance framework
This commit is contained in:
parent
5759e18b9c
commit
560a17bbe6
2 changed files with 65 additions and 0 deletions
46
PRODUCT.md
Normal file
46
PRODUCT.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# WalletPress — Product Charter
|
||||
|
||||
**Product:** WalletPress
|
||||
**Repo:** git.rugmunch.io/RugMunchMedia/walletpress
|
||||
**Deploy path:** /srv/walletpress/ on Talos
|
||||
**Container:** walletpress-backend
|
||||
**Health:** http://127.0.0.1:8010/health
|
||||
**Status:** Active development
|
||||
|
||||
## Problem
|
||||
WordPress sites and applications need an integrated multi-chain wallet engine, key vault, and x402 micropayment layer without building it from scratch.
|
||||
|
||||
## User
|
||||
- WordPress site operators
|
||||
- SaaS builders needing wallet generation
|
||||
- Operators managing chain vaults
|
||||
|
||||
## Scope
|
||||
- Python FastAPI backend
|
||||
- WordPress plugin (PHP/JS)
|
||||
- Wallet engine + chain vault
|
||||
- x402 service for micropayments
|
||||
- CLI tool for wallet management
|
||||
- Standalone MCP server
|
||||
|
||||
## Anti-scope
|
||||
- No token scanning (lives in rmi-backend)
|
||||
- No web scraping (lives in pryscraper)
|
||||
- No social feed (lives in degenfeed-web)
|
||||
- No RMI frontend code
|
||||
|
||||
## Success criteria
|
||||
- /health returns ok
|
||||
- CI green
|
||||
- All files <500 lines
|
||||
- WP plugin installable from zip
|
||||
- MCP tools typed
|
||||
|
||||
## Current reality
|
||||
- Health returns ok
|
||||
- Best pre-commit hooks in fleet (web3-safety + hallucination-check)
|
||||
- 11 files >500 lines
|
||||
- 112 f-string logs, 2 bare except, 1 time.sleep
|
||||
|
||||
## Fleet dependencies
|
||||
- None standalone; can use rmi-backend for risk data
|
||||
19
TODO.md
Normal file
19
TODO.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# WalletPress — TODO
|
||||
|
||||
## Active
|
||||
- [ ] Split 11 files >500 lines
|
||||
- [ ] Convert 112 f-string logs to structured logs
|
||||
- [ ] Fix 2 bare except clauses
|
||||
- [ ] Replace 1 time.sleep with asyncio.sleep
|
||||
|
||||
## Next
|
||||
- [ ] Add GitHub Actions CI if missing
|
||||
- [ ] Add PRODUCT.md and TODO.md to pre-commit protected docs list
|
||||
- [ ] Define WP plugin release process
|
||||
|
||||
## Blocked
|
||||
- None
|
||||
|
||||
## Done
|
||||
- ARCHITECTURE.md and ROADMAP.md exist
|
||||
- Pre-commit hooks include web3-safety and hallucination-check
|
||||
Loading…
Add table
Add a link
Reference in a new issue