Move all documentation to this repo
@tsuberim ya está trabajando en esto.
Desde el 9/4/2018.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
Make this repo the only place for documentation for the entire DAOstack project.
How it will work:
- Documentation from all subprojects will be in this repo in a seperate folder (
/arcfor Arc,/arc-jsfor Arc.js) - Documentation generated from source code will be generated locally and committed to this repo (not committed to subproject repo).
- A CI service will compile and deploy a single website to the
gh-pagesbranch of this repo.
Benefits:
- Easy to document cross-cutting concerns (e.g. an end-to-end tutorial on how to use the whole DAOstack together).
- Easier linking between subprojects (with the ability to check for broken links between subprojects).
- Consistent look & feel using the same website.
- Removing unnecessary complexity from the subprojects repos i.e managing the website.
- Supports switching markdown compilers if we need to in the future (e.g. switch to Jekyll or read the docs) or changing the behavior of the website.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 10
- Forks
- 1
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de daostack/docs
-
Extraneous "a" in WhitepaperAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
Mispelled "feely" in page 32Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 25/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100