sillsdev / sillsdev/TheCombine
[UserGuide] Automate handling of downloaded .md translations
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 22
- Forks
- 10
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 9
Description
There are several modifications necessary to .md files downloaded from Crowdin (translations of our User Guide files). Some of them have been automated with tools in Crowdin, but one big one remains: some, but not all, of the images are localized, and for those that are localized, the url within the file needs to be changed from .png to .[es/zh].png.
Options:
- Duplicate the non-localized images as if they were localized and add them to the repo.
- Write a script to make those updates depending on whether the localized file is available.
- Have a User Guide pre-build/serve step that duplicates the non-localized images temporarily.
The third is preferable if not too complicated.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the User Guide pre-build/serve entry point and the .md files downloaded from Crowdin. Check how localized and non-localized images are currently referenced, then determine whether the preferred temporary duplication approach fits the build flow. Done means translated guides serve with valid image URLs without requiring permanent duplicate images.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100