Skip to content

docs: refine bilingual documentation and reading layout - #58

Merged
fjarmula merged 4 commits into
mainfrom
codex/refine-documentation
Oct 29, 2026
Merged

fjarmula merged 4 commits into
mainfrom
codex/refine-documentation

Conversation

@fjarmula

Copy link
Copy Markdown
Member

Summary

  • Revise Polish documentation for natural wording, preserve GreenWave as a proper noun, and remove promotional claims. Remove “Running it” in both languages and rename the page Documentation / Dokumentacja.
  • Replace the panel grid with a desktop section rail and reading column; use horizontal tabs and labelled source details on phones. Preserve keyboard navigation and reveal the new heading after switching from a scrolled section.
  • Use SVG external-link icons, add the GitHub repository link, shorten the hosting name to Oracle Cloud, and show a simulation-mode status badge. Explain all diagram arrow styles, including the internal exchange with simulated ITS.

Verification

  • Frontend lint, typecheck, formatting, all 1,247 tests and the production build pass.
  • Chromium: 50 section/language/viewport combinations, keyboard activation, long-scroll section changes, and light/dark screenshots.
  • Additional browser checks cover the repository link, Oracle Cloud wording, and status badge at phone/desktop widths in both themes.
  • WebKit rendered the layouts and screenshots, but its strict run reported access-control errors on local navigation RSC prefetch requests; that run is not a clean pass.

Contract or safety impact

No API, schema or simulation behavior changes. The documentation states that the application is for demonstration purposes and that the ITS exchange occurs within the simulation.

Follow-ups

Confirm the final page on a physical iPhone with Safari. Investigate the local WebKit RSC prefetch access-control failures for /driver and /compare, reproduced on both localhost and 127.0.0.1.

@fjarmula
fjarmula requested a review from piotr-lorek as a code owner October 29, 2026 16:52
@fjarmula
fjarmula merged commit 31d1df0 into main Oct 29, 2026
7 checks passed
@fjarmula
fjarmula deleted the codex/refine-documentation branch October 29, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant