mirror of
https://github.com/PR0M3TH3AN/VoxVera.git
synced 2026-10-27 09:40:40 +00:00
2.6 KiB
2.6 KiB
AI Agent Instructions for VoxVera
This guide is for AI agents (like Gemini, Claude, or GPT) contributing to the VoxVera project. Follow these protocols to maintain the architectural integrity and multi-language support.
Core Mandates
- Security-First: VoxVera is a Tor-based tool. Never suggest features that leak IP addresses or use non-Tor external resources (CDNs, etc.).
- Local-First: All assets (fonts, dependencies, binaries) must be self-contained within the
voxvera/package to support the Universal Mirroring model. - Tokenized UI: Never hardcode user-facing strings. Always add them to
voxvera/locales/en.jsonand use thet('cli.token')helper. - Markdown Redaction: Use
~~text~~in locale JSONs for strike-through effects. Both the build system and the JS engine handle the conversion to<span class="redacted">automatically. - Visual Width Testing: When modifying UI or adding languages, verify that long or complex strings (e.g., Hindi ligatures or CJK characters) do not exceed the visual unit limits defined in the CLI.
Localization Protocol
When adding a new language or updating an existing one:
- CLI/Flyers: Update
voxvera/locales/{lang}.json. Includemeta,cli,web, andlandingcategories. - Landing Page:
- Directly update the
const localesobject insite/index.html. - Crucial: Run
voxvera build-siteto generate the latest portable bundle and refresh the pre-rendered HTML.
- Directly update the
- Documentation:
- Master templates live in
docs/templates/. - Localized overrides live in
voxvera/locales/{lang}/docs/. - Crucial: After any change to locales or templates, you MUST run
voxvera build-docsto synchronize the output indocs/{en,es,de}/.
- Master templates live in
Universal Mirroring
VoxVera propagates through its own flyers.
- Every
voxvera buildandvoxvera build-sitegeneratesvoxvera-portable.zip. - If you modify the core source code, ensure the
bundle_portablefunction invoxvera/cli.pystill correctly captures all necessary directories (especiallyvendor/,locales/, andresources/).
Verification Checklist
Before finishing a task, ensure you have:
- Run unit tests:
pytest tests/test_cli.py. - Verified the localization:
voxvera --lang {lang} check. - Rebuilt the documentation:
voxvera build-docs. - Synchronized the public site:
voxvera build-site. - Verified the portable bundle exists:
ls -l voxvera/host/*/download/voxvera-portable.zipandls -l site/download/voxvera-portable.zip.
Follow these rules to ensure VoxVera remains a robust, viral, and decentralized tool for truth.