Skip to content
This repository was archived by the owner on May 29, 2026. It is now read-only.

docs(readme): document multi-language local preview#119

Merged
WilcoLouwerse merged 1 commit into
developmentfrom
docs/readme-language-preview
May 28, 2026
Merged

docs(readme): document multi-language local preview#119
WilcoLouwerse merged 1 commit into
developmentfrom
docs/readme-language-preview

Conversation

@WilcoLouwerse

@WilcoLouwerse WilcoLouwerse commented May 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a "Previewing both languages locally" subsection under the README's Languages section.
  • Explains that docusaurus start only serves one language at a time and that the navbar switcher's /nl/ (or / from Dutch) will appear as a soft 404 — Docusaurus's internal "Page Not Found" rendered by the SPA router, not a real missing page.
  • Points contributors at npm run preview (build + serve) for both languages on port 3000, and npm run serve to reuse an existing build/.

Test plan

🤖 Generated with Claude Code

The Docusaurus dev server only serves one language at a time, which
makes the navbar language switcher look broken locally. Document the
`npm run preview` / `npm run serve` path for testing both languages on
one port.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@MWest2020

Copy link
Copy Markdown
Member

Code Review — PR #119: docs(readme): document multi-language local preview

Overview

Tiny README-uitbreiding (14 regels, geen deletions) onder de bestaande Languages-sectie. Documenteert dat docusaurus start slechts één locale tegelijk serveert, het "soft 404"-gedrag van de language switcher op de dev-server, en wijst contributors naar npm run preview voor end-to-end testen van beide locales op één port.

Sterke punten

  • "Soft 404"-uitleg is exact de mental-model-correctie die nieuwe contributors op deze repo nodig hebben. Zonder deze tekst denkt iemand bij het zien van "Page Not Found" op /nl/ dat de NL-content kapot is, terwijl het puur het dev-server-locale-isolatie-gedrag is.
  • Concrete commands met expliciete URLs (http://localhost:3000/ en http://localhost:3000/nl/) — niet hoeven raden welk pad welk language is.
  • Trade-off expliciet benoemd: "no hot-reload — re-run for every change". Voorkomt dat iemand npm run preview als hot-reload-vervanger gaat gebruiken en gefrustreerd raakt.
  • Goede landing-plek: direct onder de bestaande Languages-sectie, niet in een losse "How to test" bijzin verstopt.
  • Refereert naar npm run preview en npm run start:nl die in PR release: promote development to main (academy tutorials + ConNext pivot + partners on app/solution pages) #118 zijn toegevoegd — synchroon met de huidige codebase op development.

Aandachtspunten

Geen blockers, één micro-suggestion

  • Misschien expliciet noemen dat dit het Docusaurus dev-server-gedrag is en geen Conduction-specifiek issue. De huidige tekst zegt "Docusaurus's internal 'Page Not Found'" — dat dekt het, maar nieuwe contributors die nooit eerder met Docusaurus hebben gewerkt linken de inconsistentie misschien aan deze repo specifiek. Eén regel "(this is a Docusaurus framework behavior, not a project bug)" zou de kous af doen.

Echt een nit. Niet veranderen als de huidige tekst gelijk leest.

Verdict

Approve. Schone docs-PR die exact één specifiek pijnpunt voor contributors verhelpt. Geen risico, geen testbehoefte buiten wat het test plan al lijst.

🤖 Generated with Claude Code

@WilcoLouwerse
WilcoLouwerse merged commit 1692a38 into development May 28, 2026
@WilcoLouwerse
WilcoLouwerse deleted the docs/readme-language-preview branch May 28, 2026 12:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants