ember-learn / ember-learn/ember-cli-addon-docs

Make writing docs easier (for non-tech/ember people)

Abierto
#253 2 comentarios 1 reacción 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
172
Forks
142
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

At the moment, writing pages for ec-addon-docs that requires you to do the following:

- Find `tests/dummy/app` folder
- Create a route in `tests/dummy/app/router.js`
- Create the respective `my-route.md` (or `my-route/template.md`) file
- Possibly create a `section/template.hbs` for the layout of a new section

This is not hard to do for us ember folks but if other people (e.g. designers) jump in and want to provide texts they probably have a hard time doing so (just try to remember that cryptic folder path to the dummy app might be exhausting enough). There should be an easier way. An easy shot might be the following (a little jekyll inspired):

- Leverage the `docs/` root folder
- People will use folders inside for different sections
- They will only write markdown
- Markdown contains a front matter (delimited via `--`)
- Front Matter contains meta data (e.g. `layout`)
- e.g. `layout` is predefined by a developer and maps to the respetice `section/template.hbs`
- `docs/` folder has some "magic" meta files (starting with underscore). Those meta files will provide navigation for various sections

An example:

```
- docs
- sandbox
- _nav.md
- index.md
- quick-start.md
```

The `docs` folder can be watched and will be hoisted/mapped into the dummy app, creating routes on the fly =) (can be optimized on release)

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Revisa el flujo actual a través de tests/dummy/app, especialmente router.js, los archivos Markdown de las rutas y section/template.hbs. Define cómo se asignarían un árbol docs/, el front matter, los archivos _nav.md y los cambios observados a la aplicación dummy; se considerará terminado cuando los contribuidores puedan escribir Markdown sin tener que crear manualmente rutas o plantillas de Ember.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, markdown
Área
documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.