From 4e6508acf899c7fc259ad2b93e2b026575e59ab9 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Fri, 13 Mar 2026 16:05:33 -0400 Subject: [PATCH] docs: Call out Markdown strike-through support in contributing and agent guides --- AGENTS.md | 1 + CONTRIBUTING.md | 3 ++- docs/de/AGENTS.md | 1 + docs/de/CONTRIBUTING.md | 3 ++- docs/en/AGENTS.md | 1 + docs/en/CONTRIBUTING.md | 3 ++- docs/es/AGENTS.md | 1 + docs/es/CONTRIBUTING.md | 3 ++- docs/templates/AGENTS.md | 1 + docs/templates/CONTRIBUTING.md | 3 ++- 10 files changed, 15 insertions(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index b459e2b..667fff5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,6 +7,7 @@ This guide is for AI agents (like Gemini, Claude, or GPT) contributing to the Vo 1. **Security-First**: VoxVera is a Tor-based tool. Never suggest features that leak IP addresses or use non-Tor external resources (CDNs, etc.). 2. **Local-First**: All assets (fonts, dependencies, binaries) must be self-contained within the `voxvera/` package to support the Universal Mirroring model. 3. **Tokenized UI**: Never hardcode user-facing strings. Always add them to `voxvera/locales/en.json` and use the `t('cli.token')` helper. +4. **Markdown Redaction**: Use `~~text~~` in locale JSONs for strike-through effects. Both the build system and the JS engine handle the conversion to `` automatically. ## Localization Protocol diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4019b4f..7c0ec5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,8 @@ Create a new JSON file in `voxvera/locales/{lang_code}.json`. - **`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. -- **`landing`**: Translate the specific content for the official VoxVera website (Title, Headline, etc.). +- **`landing`**: Translate the specific content for the official VoxVera website. +- **Formatting**: You can use Markdown-style strike-throughs (`~~redacted text~~`) in any of these strings; they will be automatically converted to the stylized "redacted" effect on the flyers. ### 2. The Landing Page The main landing page (`site/index.html`) must be synchronized to include your new language. diff --git a/docs/de/AGENTS.md b/docs/de/AGENTS.md index b459e2b..667fff5 100644 --- a/docs/de/AGENTS.md +++ b/docs/de/AGENTS.md @@ -7,6 +7,7 @@ This guide is for AI agents (like Gemini, Claude, or GPT) contributing to the Vo 1. **Security-First**: VoxVera is a Tor-based tool. Never suggest features that leak IP addresses or use non-Tor external resources (CDNs, etc.). 2. **Local-First**: All assets (fonts, dependencies, binaries) must be self-contained within the `voxvera/` package to support the Universal Mirroring model. 3. **Tokenized UI**: Never hardcode user-facing strings. Always add them to `voxvera/locales/en.json` and use the `t('cli.token')` helper. +4. **Markdown Redaction**: Use `~~text~~` in locale JSONs for strike-through effects. Both the build system and the JS engine handle the conversion to `` automatically. ## Localization Protocol diff --git a/docs/de/CONTRIBUTING.md b/docs/de/CONTRIBUTING.md index 4019b4f..7c0ec5a 100644 --- a/docs/de/CONTRIBUTING.md +++ b/docs/de/CONTRIBUTING.md @@ -12,7 +12,8 @@ Create a new JSON file in `voxvera/locales/{lang_code}.json`. - **`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. -- **`landing`**: Translate the specific content for the official VoxVera website (Title, Headline, etc.). +- **`landing`**: Translate the specific content for the official VoxVera website. +- **Formatting**: You can use Markdown-style strike-throughs (`~~redacted text~~`) in any of these strings; they will be automatically converted to the stylized "redacted" effect on the flyers. ### 2. The Landing Page The main landing page (`site/index.html`) must be synchronized to include your new language. diff --git a/docs/en/AGENTS.md b/docs/en/AGENTS.md index b459e2b..667fff5 100644 --- a/docs/en/AGENTS.md +++ b/docs/en/AGENTS.md @@ -7,6 +7,7 @@ This guide is for AI agents (like Gemini, Claude, or GPT) contributing to the Vo 1. **Security-First**: VoxVera is a Tor-based tool. Never suggest features that leak IP addresses or use non-Tor external resources (CDNs, etc.). 2. **Local-First**: All assets (fonts, dependencies, binaries) must be self-contained within the `voxvera/` package to support the Universal Mirroring model. 3. **Tokenized UI**: Never hardcode user-facing strings. Always add them to `voxvera/locales/en.json` and use the `t('cli.token')` helper. +4. **Markdown Redaction**: Use `~~text~~` in locale JSONs for strike-through effects. Both the build system and the JS engine handle the conversion to `` automatically. ## Localization Protocol diff --git a/docs/en/CONTRIBUTING.md b/docs/en/CONTRIBUTING.md index 4019b4f..7c0ec5a 100644 --- a/docs/en/CONTRIBUTING.md +++ b/docs/en/CONTRIBUTING.md @@ -12,7 +12,8 @@ Create a new JSON file in `voxvera/locales/{lang_code}.json`. - **`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. -- **`landing`**: Translate the specific content for the official VoxVera website (Title, Headline, etc.). +- **`landing`**: Translate the specific content for the official VoxVera website. +- **Formatting**: You can use Markdown-style strike-throughs (`~~redacted text~~`) in any of these strings; they will be automatically converted to the stylized "redacted" effect on the flyers. ### 2. The Landing Page The main landing page (`site/index.html`) must be synchronized to include your new language. diff --git a/docs/es/AGENTS.md b/docs/es/AGENTS.md index b459e2b..667fff5 100644 --- a/docs/es/AGENTS.md +++ b/docs/es/AGENTS.md @@ -7,6 +7,7 @@ This guide is for AI agents (like Gemini, Claude, or GPT) contributing to the Vo 1. **Security-First**: VoxVera is a Tor-based tool. Never suggest features that leak IP addresses or use non-Tor external resources (CDNs, etc.). 2. **Local-First**: All assets (fonts, dependencies, binaries) must be self-contained within the `voxvera/` package to support the Universal Mirroring model. 3. **Tokenized UI**: Never hardcode user-facing strings. Always add them to `voxvera/locales/en.json` and use the `t('cli.token')` helper. +4. **Markdown Redaction**: Use `~~text~~` in locale JSONs for strike-through effects. Both the build system and the JS engine handle the conversion to `` automatically. ## Localization Protocol diff --git a/docs/es/CONTRIBUTING.md b/docs/es/CONTRIBUTING.md index 4019b4f..7c0ec5a 100644 --- a/docs/es/CONTRIBUTING.md +++ b/docs/es/CONTRIBUTING.md @@ -12,7 +12,8 @@ Create a new JSON file in `voxvera/locales/{lang_code}.json`. - **`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. -- **`landing`**: Translate the specific content for the official VoxVera website (Title, Headline, etc.). +- **`landing`**: Translate the specific content for the official VoxVera website. +- **Formatting**: You can use Markdown-style strike-throughs (`~~redacted text~~`) in any of these strings; they will be automatically converted to the stylized "redacted" effect on the flyers. ### 2. The Landing Page The main landing page (`site/index.html`) must be synchronized to include your new language. diff --git a/docs/templates/AGENTS.md b/docs/templates/AGENTS.md index b459e2b..667fff5 100644 --- a/docs/templates/AGENTS.md +++ b/docs/templates/AGENTS.md @@ -7,6 +7,7 @@ This guide is for AI agents (like Gemini, Claude, or GPT) contributing to the Vo 1. **Security-First**: VoxVera is a Tor-based tool. Never suggest features that leak IP addresses or use non-Tor external resources (CDNs, etc.). 2. **Local-First**: All assets (fonts, dependencies, binaries) must be self-contained within the `voxvera/` package to support the Universal Mirroring model. 3. **Tokenized UI**: Never hardcode user-facing strings. Always add them to `voxvera/locales/en.json` and use the `t('cli.token')` helper. +4. **Markdown Redaction**: Use `~~text~~` in locale JSONs for strike-through effects. Both the build system and the JS engine handle the conversion to `` automatically. ## Localization Protocol diff --git a/docs/templates/CONTRIBUTING.md b/docs/templates/CONTRIBUTING.md index f8d5124..9c28c2f 100644 --- a/docs/templates/CONTRIBUTING.md +++ b/docs/templates/CONTRIBUTING.md @@ -12,7 +12,8 @@ Create a new JSON file in `voxvera/locales/{lang_code}.json`. - **`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. -- **`landing`**: Translate the specific content for the official VoxVera website (Title, Headline, etc.). +- **`landing`**: Translate the specific content for the official VoxVera website. +- **Formatting**: You can use Markdown-style strike-throughs (`~~redacted text~~`) in any of these strings; they will be automatically converted to the stylized "redacted" effect on the flyers. ### 2. The Landing Page The main landing page (`site/index.html`) must be synchronized to include your new language.