diff options
| author | Leitwolf11 | 2026-10-03 18:21:43 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-10-03 18:21:43 +0300 |
| commit | 8738fc4e138745f2d065cf54c25426e3d37c119d (patch) | |
| tree | 65871899976b4e6f0f04d55a50fa209d92b855e1 /Documents/CONTENT.md | |
| parent | 710dc90b0503cd1de1ae6159e01fb22d1b336aba (diff) | |
| download | website-docs/current-state.tar.gz | |
Bring the documentation up to the published site and fill its gapsdocs/current-state
The documents still described a site in maintenance with two languages and
a forum page with a language menu. They now describe what is published, and
three documents are new.
New, under Documents/:
- README.md: index of the documentation.
- ARCHITECTURE.md: the frontend, the backend and the forum page, what each
serves, what the site deliberately does not contain, and how search
engines and crawlers are treated.
- LOCALIZATION.md: the four languages, how a page picks one, what counts as
a visitor's choice, how Hebrew text is laid out, where the text lives and
how to add a language.
- DEVELOPMENT.md: requirements, the commands of each part, the dependency
locks and checksums, the tests and what CI enforces.
Updated:
- README.md: the site is public; four languages and the browser-language
default; a documentation section; the Dokka gate.
- CONTENT.md: the forum notice without a language menu; translation rules
for four languages, including preferring the term a reader would use over
a literal one; the crawler rules as an owner decision.
- OPERATIONS.md: the live route table; the release steps for the directory
layout on the server, with the SELinux labelling order that caused an
outage once; cache keys for the forum files and CDN caching; maintenance
mode as a fallback instead of the current state; rollback by directory;
checksum regeneration with --refresh-dependencies; the post-release check
for four languages and right-to-left text.
No source file changes.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'Documents/CONTENT.md')
| -rw-r--r-- | Documents/CONTENT.md | 51 |
1 files changed, 37 insertions, 14 deletions
diff --git a/Documents/CONTENT.md b/Documents/CONTENT.md index d9d43bb..031ff1d 100644 --- a/Documents/CONTENT.md +++ b/Documents/CONTENT.md @@ -93,22 +93,38 @@ management flow to link from this guide. The placeholder may say the forum will come later, once the community is ready. It must not imply that an account can be created now or that -discussion posts are stored elsewhere. Its default is English and dark, -with German, Russian and light options for consistency. Its noindex status applies +discussion posts are stored elsewhere. It shows one notice, in the language +of the browser, with English as the fallback; it has no language menu. Its +theme defaults to dark, with a light option. Its noindex status applies both in HTML and at the server boundary. ## Translation rules -`en-US` is the default and must carry complete content. `de-DE` and `ru-RU` -should express the same meaning, not mechanically mirror sentence length. Keep -technical spellings such as `Visual.XSharp.kts`, `CorePrep`, `Xpp`, and -`Xmm` stable. Translate navigation labels, help text, figure descriptions, -and accessible names. When adding a paragraph or an interaction, add every -language in the same change so a locale switch never leaves mixed copy. +`en-US` is the fallback and must carry complete content. `de-DE`, `ru-RU` +and `he-IL` should express the same meaning, not mechanically mirror sentence +length. Keep technical spellings such as `Visual.XSharp.kts`, `CorePrep`, +`Xpp`, and `Xmm` stable. Translate navigation labels, help text, figure +descriptions, and accessible names. When adding a paragraph or an +interaction, add every language in the same change so a locale switch never +leaves mixed copy. + +Prefer the term a developer who reads that language would use over a literal +rendering. A literal word can mean something else: in Hebrew, the literal +words for "native" and "lowering" read as "local" and "download". Where no +settled term exists, keep the English term in Latin letters. Avoid forms of +address that assume the reader's gender. + +Hebrew text runs right to left, and the page layout does not mirror. Follow +`Visual X#` and `C#` with a left-to-right mark in Hebrew strings so the `#` +stays with the name. [Localization](LOCALIZATION.md) describes the mechanics +and how a page picks its language. + +A translation should be read by a native speaker before it is published. The +Hebrew text has not had that review yet. The URL is shared between language preferences. Do not emit inaccurate -`hreflang` alternatives implying separate German or Russian URLs. The document `lang` -attribute and browser metadata should follow the selected locale. The +`hreflang` alternatives implying separate URLs per language. The document +`lang` attribute and browser metadata should follow the selected locale. The canonical URL should remain the supported route without tracking query parameters. @@ -150,9 +166,15 @@ has its own title, description, social title/description, and canonical URL when the application runs. The HTML shell has English home metadata so it does not present a blank title before JavaScript initializes. -Opening the public site later is a separate decision from writing this -content. Until then, main-domain 503 is expected and should not be -misdiagnosed as a broken frontend build. +`robots.txt` carries an explicit rule for each crawler the site has a +position on. Crawlers that index pages for search or fetch a page to answer +a question are allowed. Crawlers that collect training data are decided one +by one: Google-Extended and ClaudeBot are allowed, GPTBot is disallowed. +Changing one of those rules is a policy decision of the project owner, not a +cleanup. + +When the main domain is switched to its maintenance configuration, a 503 is +expected and should not be misdiagnosed as a broken frontend build. ## Review checklist @@ -161,7 +183,8 @@ Before approving a copy change, check: - Is every language claim grounded in the public Spec or compiler tests? - Does the wording say “designed to” where implementation is incomplete? - Does the command match the latest CLI and toolchain guide? -- Does the German version preserve meaning and technical identifiers? +- Do the German, Russian and Hebrew versions preserve meaning and technical + identifiers? - Are internal notes and private file paths absent from the public page? - Are homepage and docs links still valid after repository movement? - Are source attribution and the Visual X# leopard identity intact? |