mastodon / mastodon/documentation
LibreTranslate options are not clearly documented
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 1.7k
- Forks
- 978
- PR merge metrics
- No merged PRs in 30d
Description
In the docs it says
LibreTranslate needs
LIBRE_TRANSLATE_API_KEYandLIBRE_TRANSLATE_ENDPOINT
This should be improved in several ways:
LIBRE_TRANSLATE_API_KEYis in fact not required. LibreTranslate can be run without API keys. In fact, the devcontainer setup of mastodon/mastodon gives an example for this.- There should be an example for
LIBRE_TRANSLATE_ENDPOINTto illustrate whether the /translate path should be included or not (it shouldn't).
Contributor guide
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 in content/en/admin/config.md around the LibreTranslate configuration at the linked lines. Update the documentation to state that LIBRE_TRANSLATE_API_KEY is optional and show an example LIBRE_TRANSLATE_ENDPOINT without the /translate path; done means both options are accurately explained.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100