Skip to content

[Documentation] Add translation guide for adding new languages #78#205

Open
Atharavkag wants to merge 4 commits intokevinanielsen:mainfrom
Atharavkag:main
Open

[Documentation] Add translation guide for adding new languages #78#205
Atharavkag wants to merge 4 commits intokevinanielsen:mainfrom
Atharavkag:main

Conversation

@Atharavkag
Copy link

Linked Issues

Closes #78

Summary

Adds comprehensive documentation and step-by-step guides for translating go-fast-cdn into new languages. This ensures the project is accessible to international contributors.

Changes

  • New Guide: Created docs/how-to-add-a-language.md with a step-by-step workflow.
  • Examples:Added Spanish (es/) and French (fr/) directories to demonstrate the pattern.
  • Tracking: Included README files within language folders for translation progress.
  • References: Updated links to the existing Danish (da/) documentation.

Why this is important

  • Solves the lack of contributor guidance for i18n (Internationalization).
  • Lowers the barrier to entry for non-English speaking developers.
  • Standardizes how translations are structured across the repo.

Verification & Testing

  • Content Check:Verified all Markdown links are functional.
  • Structure: Confirmed new folders match the existing documentation architecture.
  • Scope: Documentation only; no functional code changes included.

…ielsen#78)

- Created comprehensive guide for adding new languages
- Added Spanish (es) example with partial translation
- Added French (fr) example showing similar pattern
- Included README files to track translation progress
- Linked to existing Danish (da) example as reference
…ielsen#78)

- Created comprehensive guide for adding new languages
- Added Spanish (es) example with partial translation
- Added French (fr) example showing similar pattern
- Included README files to track translation progress
- Linked to existing Danish (da) example as reference
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason, I can't add comments per line, but the abbreviation for French in step 1 should be /fr, not /r/.

The formatting for code snippets also looks wrong. Use three backticks, ``` instead of the backslashes. e.g. for a bash snippet:

```bash
hello!
```

There are issues with backslash vs regular slashes in a lot of places.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should not be committed

@Atharavkag
Copy link
Author

@kevinanielsen Thank you for the thorough review. I've addressed all the issues you pointed out:

  1. Fixed Markdown formatting in docs/add-language.md:

    • Corrected all code blocks to use proper triple backticks (bash)
    • Fixed inline code formatting (e.g., /docs/ instead of \/docs/\)
    • Standardized path separators
  2. Removed package-lock.json as requested.

All changes have been pushed. Please let me know if there's anything else that needs adjustment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Write documentation for adding another language with i18n to the docs

2 participants