Popup.md is hard to comprehend

Question

Popup.md is hard to comprehend

arteg opened this issue 10 years ago · 3 comments

Feels like docs for popup is all messed up, there is little to no structure and links lead to nowhere.

Answer 1 · 2014-10-17T12:51:29.000Z

And your suggestion of solution is?

Answer 2 · 2014-10-17T13:12:51.000Z

I filed this issue now so I wouldn't forget about it. I'll formulate concrete suggestions later. For now there is only what comes from the description: more structured docs needed.

Answer 3 · 2014-10-22T19:25:32.000Z

I get it, we opted for autogenerated JSDoc which can be seen at http://yandex-ui.github.io/nanoislands/

Previous .md files contained nicely structured API description and since links under the title "Documentation" on the main page still lead to those files, I got frustrated.

We need to make API docs at gh-pages more accessible and pretty (now there is even no indentation) and make it clear in README.md that docs should be viewed at the demo page.