PathOfBuildingCommunity / PathOfBuildingCommunity/PathOfBuilding
Help Section Improvements
Personne n'a encore pris cette issue.
- Langage dominant
- Lua
- Étoiles
- 5.4k
- Forks
- 2.4k
- Merge moyen
- 1 j 12 h
- PR mergées (30 j)
- 26
Description
There are a number of improvements needed for the help section to be properly useful, PRs do not need to cover all sections and it is recommended you focus on only 1 or a few points at a time
help section can currently be accessed on the "about" popup (bottom left corner of the UI)
missing content:
- FAQ
- items tab
- - trader tool
- config tab
- - boss/enemy config
- - custom mods
- calcs tab
- skills tab
- other notable things
- - glossary of terms (from #2681)
other improvements wanted: (though these likely will not be merged until more content is added)
- make it easier to access/see (hotkey and/or button on main UI)
- add ability to colour lines or headers in the help section
- add ability to embed clickable links into help section (eg https://github.com/PathOfBuildingCommunity/PathOfBuilding/wiki/Keyboard-&-Mouse-Shortcuts )
- add markup version (.md) to webpage (https://pathofbuilding.community/)
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 la section Help accessible depuis la fenêtre contextuelle About en bas à gauche de l’UI, et choisissez un élément de contenu ou de présentation non coché plutôt que d’essayer de traiter toute la liste. C’est terminé lorsque le contenu de Help ou l’amélioration sélectionné est implémenté et peut être vérifié dans la section Help ; l’élément concernant la page web Markdown doit être coché séparément sur https://pathofbuilding.community/.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua, markdown
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100