Come up with plan for API documentation tooling
Personne n'a encore pris cette issue.
- Langage dominant
- C++
- Étoiles
- 74
- Forks
- 9
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
We depend on documentation 4.0.0 as more recent releases removed `polygot` - refs documentationjs/documentation#850.
We either need to:
- [ ] Switch to a different tool
- [ ] Fix our usage of documentationjs to keep working with more recent versions
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner la dépendance actuelle à documentation 4.0.0 et l’issue #850 de documentationjs mentionnée concernant la fonctionnalité polygot supprimée. Comparez les deux approches proposées —changer d’outil ou corriger l’utilisation pour les versions plus récentes— et définissez l’achèvement comme une configuration documentée et fonctionnelle de la documentation de l’API.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cpp, node.js
- Domaine
- api, documentation, tooling
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100