DOCS: Create AboutCode doc system
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 30/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- javascript, markdown
- Domaine
- documentation
Piste de recherche
Commencez par examiner la documentation existante à l’adresse aboutcode.readthedocs.io/ ainsi que le framework Diátaxis mentionné dans l’issue. Définissez la structure et les recommandations proposées pour la documentation des projets, les fichiers README, les fichiers CONTRIBUTING et les descriptions des dépôts ; la tâche sera considérée comme terminée lorsque le système de documentation sera publié et expliquera comment les projets AboutCode doivent l’appliquer.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
- Langage dominant
- JavaScript
- Étoiles
- 9
- Forks
- 17
- Merge moyen
- 7 h 55 min
- PR mergées (30 j)
- 2
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
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.
Autres issues de aboutcode-org/www.aboutcode.org
-
Making all post button.Peut-être pris @sarthaklole l’a pris il y a 70 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
aboutcode-org/www.aboutcode.org#117 · 3 commentaires ·
-
WWW: Reduce frequency of update-releasesPeut-être à nouveau libre @johnmhoran l’a pris il y a 51 jours, et aucune pull request n’est ouverte. Ouverteci-workflow
Difficulté 2/5 1-3 heures Accessibilité débutants 45/100
aboutcode-org/www.aboutcode.org#180 · 1 personne assignée ·
-
DOCS: Create new AboutCode stack diagram(s)Peut-être à nouveau libre @hixvikas l’a pris il y a 52 jours, et aucune pull request n’est ouverte. Ouvertedocumentation
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
aboutcode-org/www.aboutcode.org#166 · 1 commentaire ·
-
WWW: Create About top level page?Peut-être pris @pombredanne l’a pris il y a 154 jours. Ouvertewebsite
Difficulté 2/5 1-3 heures Accessibilité débutants 35/100
aboutcode-org/www.aboutcode.org#164 · 1 réaction · 1 personne assignée ·
-
WWW: Add Initiatives and grant ProjectsPeut-être à nouveau libre @mjherzog l’a pris il y a 241 jours, et aucune pull request n’est ouverte. Ouverteenhancement needs design website
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
aboutcode-org/www.aboutcode.org#141 · 1 personne assignée ·
Toutes les issues de aboutcode-org/www.aboutcode.org
Issues similaires
-
[Feature Request] [Web] Expose kvCacheQuantizationBits in the onnxruntime-web WebGPU EP optionsOuverteep:WebGPU platform:web quantization
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
microsoft/onnxruntime#33752 ·
Les mainteneurs répondent en général sous 2 jours
-
More Transport Mode IconsOuverteicon request
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
tabler/tabler-icons#1693 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 1-3 heures Accessibilité débutants 72/100
alvarotrigo/fullPage.js#4755 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
jlab-sensing/ENTS-backend#854 ·
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
andromarces/agent-loops#1242 ·
Les mainteneurs répondent en général sous 1 jour