react-boilerplate/react-boilerplate

Move docs to gitbook

Open

#951 ouverte le 2 sept. 2016

Voir sur GitHub
 (17 commentaires) (3 réactions) (0 assignés)JavaScript (29 470 stars) (6 123 forks)batch import
enhancementhelp wanted

Description

What do you think about creating documentation using gitbook? If you've never seen what it looks like, here's a good example.

You just need to connect your repository and select the folder which contains the documentation.

We have already done this for one project.

Guide contributeur

Stack technique
javascriptreacthtmlcss
Domaine
documentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
needs investigation
Prérequis
basic GitBook knowledgefamiliarity with GitHub repo integration
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
35
Direction de recherche
This issue proposes migrating documentation to GitBook, referencing a successful example in another project. It is a discussion open for maintainer feedback. To proceed, a contributor should study the GitBook setup process and evaluate whether the repository's documentation structure can be easily integrated. The original comment links to a tutorial and an example documentation site.