pokeapi.co icon indicating copy to clipboard operation
pokeapi.co copied to clipboard

Proposal: UI/UX Improvements (i18n & Theming)

Open DONCHUY846 opened this issue 5 months ago • 5 comments

Proposal: UI/UX Improvements (i18n & Theming)

@Naramsim

I propose contributing in front-end by implementing the following enhancements:

  • Internationalization (i18n) Support: Implement i18n to allow for multi-language documentation and UI, enabling future community translations.
  • Theme Refinement (Dark/Light Mode): Improve the existing Dark and Light themes for better visual polish and WCAG accessibility compliance (contrast, readability).

Check my profile

DONCHUY846 avatar Dec 13 '25 16:12 DONCHUY846

Hi @DONCHUY846 we had a previous contributor that started a Astro fork for our website. @Indyandie I think. Can you check out the work he had done and maybe consider starting from his branch?

Naramsim avatar Dec 14 '25 00:12 Naramsim

The branch is feat/astro-starlight

Naramsim avatar Dec 14 '25 00:12 Naramsim

Here the relevant issue: https://github.com/PokeAPI/pokeapi.co/issues/162

Naramsim avatar Dec 14 '25 00:12 Naramsim

I'll try to push an update when I'm on my holiday break.

The Starlight implementation supports dark/light modes out of the box, and there is plugin/support for internationalization. The last change that's left is migrating the API sections.

Import all the API v2 sections as they appear now (https://pokeapi.co/docs/v2), or find a way to include the same information in the OpenAPI section. One thing the OpenAPI section seems to be lacking is descriptions of the types of the objects.

I wanted to do this directly in the OpenAPI spec, but that may take some time unless I can get into a good flow and make some quick progress ("vibing and clanking").

Indyandie avatar Dec 14 '25 05:12 Indyandie

Yeah as of now you can use the JSON already present in the master branch

https://github.com/PokeAPI/pokeapi.co/tree/master/src%2Fdocs

Naramsim avatar Dec 14 '25 08:12 Naramsim