datacamp / datacamp/rdocumentation-2.0

Please support internationalisation through indexing help translation modules

Open
#168 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
301
Forks
54
Avg merge
16h 19m
Merged PRs (30d)
1

Description

Hello,

After creating multiple internationalisation modules of R packages, thanks to {rhelpi18}, I'd love to find them them in rdocumentation.org.

Is there a chance you can add internationalisation module github repositories to the index ?

The general pattern according to {rhelpi18n} is that the DESCRIPTION file in the repository contains three major keys :

  • Type: Translation-module
  • Language:
  • Translates:

example from {tabnet.fr}

Package: tabnet.fr
Type: Translation-module
Title: Entraîne des modèles 'Tabnet' pour la Classification et la Régression
Version: 0.6.0
Date: 2024-05-26
Authors@R: c(
    person("Christophe", "Regouby", , "christophe.regouby@free.fr", role = c("aut", "cre", "cph"))
  )
Description: La version française de l'implémentation des modèles 'TabNet' par Sercan O. Arik et al. (2019)
    <doi:10.48550/arXiv.1908.07442> avec 'Coherent Hierarchical Multi-label
    Classification Networks' par Giunchiglia et al.  <doi:10.48550/arXiv.2010.10151> et
    qui founit une interface homogène pour l'entraînement et l'inférence. 
    Il est aussi entièrement compatible avec l'écosystème 'tidymodels'.
License: MIT + file LICENSE
BugReports: https://github.com/cregouby/tabnet.fr/issues
Language: fr_FR
Translates: tabnet (== 0.6.0)
...

thanks a lot !

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the package-indexing entry point and the metadata handling for DESCRIPTION files. Use the rhelpi18n pattern and the tabnet.fr example as the input case, then verify that Type, Language, and Translates are recognized and the translation module appears in the index.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation, internationalization, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.