mirror of
https://github.com/PR0M3TH3AN/VoxVera.git
synced 2026-10-31 03:30:50 +00:00
42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
# Contributing to VoxVera
|
|
|
|
Thank you for your interest in contributing to VoxVera! This project aims to be a global, censorship-resistant tool, and your help—especially with translations—is vital.
|
|
|
|
## Adding a New Language
|
|
|
|
VoxVera uses a centralized token system for the CLI and Web components, and a template-based system for Documentation. To add a new language (e.g., French/`fr`), follow this checklist:
|
|
|
|
### 1. The Token File
|
|
Create a new JSON file in `voxvera/locales/{lang_code}.json`.
|
|
- Use `en.json` as your master template.
|
|
- **`meta`**: Include the native language name and a flag emoji.
|
|
- **`cli`**: Translate all strings used in the terminal interface.
|
|
- **`web`**: Translate strings used on the generated landing pages and flyers.
|
|
|
|
### 2. The Landing Page
|
|
The main landing page (`site/index.html`) requires a direct update because it is a static file.
|
|
- Open `site/index.html`.
|
|
- Locate the `const locales` object in the `<script>` tag.
|
|
- Add your language's `meta`, `landing`, and `web` tokens.
|
|
|
|
### 3. Documentation
|
|
VoxVera uses the **Doc-Sync Engine** to keep manuals in sync.
|
|
- Create localized Markdown files in `voxvera/locales/{lang_code}/docs/`.
|
|
- Use the templates in `docs/templates/` as your guide.
|
|
- You can use `cli.token_name` to reference terminal commands automatically.
|
|
|
|
### 4. Build and Verify
|
|
Run the following commands to verify your changes:
|
|
- `voxvera --lang {lang_code} check` (Verify CLI translation)
|
|
- `voxvera build-docs` (Generate localized manuals)
|
|
- Open `site/index.html` in a browser and test the language switcher.
|
|
|
|
## Code Contributions
|
|
- Ensure all tests pass: `pytest tests/test_cli.py`.
|
|
- Follow the existing coding style (PEP 8 for Python).
|
|
- If adding a new feature, update the master templates in `docs/templates/` and run `voxvera build-docs`.
|
|
|
|
---
|
|
|
|
Together, we can ensure that truth remains accessible to everyone, everywhere.
|