dthree / dthree/wat

Trying to create new docs - wont index

Open
#31 14 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
508
Forks
22
PR merge metrics
No merged PRs in 30d

Description

Hi,

I need a jump-start again.

I am trying to create new documentation for protractor. As there are no good api-docs for protractor in markdown-format on github, I want to paste them hand-crafted from [angular.github.io/protractor](http://angular.github.io/protractor/#/api?view=Protractor) to the `docs/` folder.

What I have done:
- create no subfolder `docs/protractor`
- create two files: `docs/protractor/element/all/index.md` and `docs/protractor/element/index.md`
- copied config.json from `docs/js` to `docs/protractor` and edited it to contains both functions 'element' and 'element/all'
- run `index`in wat -> nothing happens
- run `gulp index` on shell -> nothing happens

What have I exactly to do, to add this new docs?

For me it looks on the first view exactly like the js doc. The files `config/config.json` and `config/index.json` were also updated automatically by index command.

For clarity you can see the wip here: https://github.com/defel/wat/tree/protractor-docs/docs/protractor

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.