[2pt] Add API-related recommendations to Translation Guidelines
Open
Nobody has claimed this yet.
guidelines
translate
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Audience/target: translation team; TWs?
Root document: https://www.tarantool.io/en/doc/latest/contributing/docs/localization/guide/
SME: @ patiencedaur, @ veod32
What to write about
- How are "return" and "return type" automatically rendered by Sphinx? describe the case of "возвращает: таблицу" instead of "возвращает: таблица"
Definition of done
- There is a new section in Tarantool Translation Guidelines, titles API
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
Open the Tarantool Translation Guidelines at the linked root document and review its existing structure and API terminology. Investigate how Sphinx renders “return” and “return type,” including the “возвращает: таблицу” example, then add a section titled API with those recommendations. Done means the new section is present and covers the requested rendering guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100