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

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

Open
#253 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
172
Forks
142
PR merge metrics
No merged PRs in 30d

Description

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)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.