Project 9 Summary
We added versions to our API and create a migration guide and introduction pages.
What made you smile?
- Everything was smooth without any issues on the way.
What did you find confusing?
- Duplicated content in both documentation pages (?)
- When I translate sidebar I think that breadcumbs also be translated (?)
- When you change main file you can forget about change the translated file, so it could be added some "notification", some link to the translated file?
Small issues
- changing files in editor take a while (2s?) its longer than on previous trainings
Improvements
- We should have already translated common components like "Send button" to all popular languages - like Django Framework do it, you have all translation to common pages like login/create account and common words like "Send", "Retry", so enabling plPL in redocly yaml should translates "Last updated" to "Zaktualizowano" by default without user extra actions.
Duplicated Content
The two documents contain overlapping information, particularly regarding the following topics:
## Internationalization Overview:
- Support for multiple languages
- Supported content types (UI components, React pages, etc.)
## Directory Structure and Setup:
- Creation of `@i18n` directory and subdirectories for languages
- Example directory structures
## Translations.yaml File:
- Necessity for translation key-value pairs
- Usage for translating UI components and content
## Translation Implementation:
- Translating base UI components, React pages, navbar, footer, and sidebar labels
- Examples of translation keys and corresponding values
## Default Values and Fallback Mechanism:
- How missing translation keys are handled
- Usage of default values in React components and configuration files
This duplication ensures that both documents independently cover all necessary steps and details for configuring internationalization, but it also means that many sections are repeated verbatim or with slight variations.