Документация по noscript

[edoroshenko]

Создаём документацию в папке doc в .md-файлах Индекс документации собираем на wiki: https://github.com/yandex-ui/noscript/wiki

Что осталось сделать:

1. Написать про сущности noscript
   • [x] Раскладка страницы
   • [x] Модель
   • [x] Модель-коллекция
   • [x] Вид
   • [x] Вид-коллекция
   • [x] Маршрутизатор
   • [x] Инициализация noscript
   • [ ] ns.page, события, история
2. Написать про паттерны
   • [x] Модель состояния
   • [ ] Коллекция коллекций
   • [x] Отложенная дорисовка вида
   • [ ] Модель-объединение
   • [ ] Очередь
   • [ ] Операция
   • [ ] viewFetch (?)

Дополняем этот список. Пишем прямо в описании свой ник напротив раздела, которым занимаемся, чтобы не пересечься.

[chestozo]

Вот пример того, как я бы хотел, чтобы у нас выглядела документация: http://chestozo.github.io/layout.html http://chestozo.github.io/view.html

Там используется крутая штука http://strapdownjs.com/ которая налету транформирует markdown в html. Маркдаун я пока руками скопировал, но несложно сделать так, чтобы качался актуальный md файл из репы noscript. Внизу есть комменты - это очень круто, мне кажется )

Что скажите? Хочется ещё table of contents какой-нибудь )

[chestozo]

Исходники этих доков https://github.com/chestozo/chestozo.github.io

[Lapple]

С телефона верстка бьется. Можно же и на гитхабе открывать, там вроде mobile-friendly.

[chestozo]

Ты издеваешься? ) я же не продакшн решение предлагаю, а концепт ;)

[bt4R9]

/offtop По следам 251202306ee145748502a1d0cfd06e219e6bb61b. Хочется больше информации.

1. Зачем это убирать, а не дорабатывать?
2. На что заменять?

[edoroshenko]

Саш, про data-binding сюда: #227

[bt4R9]

спасибо

[edoroshenko]

@doochik пишет про view, model @chestozo пишет про router @Lapple пишет про инициализацию ns я пишу про поэтапную загрузку данных и модель состояния

[Lapple]

Предварительно описал инициализацию, все ли хорошо, чего не хватает?

[doochik]

Описал модель и вид

[chestozo]

Описал ns.router https://github.com/yandex-ui/noscript/blob/master/doc/ns.router.md

[edoroshenko]

Описал ns.router

Давайте делать всё в одинаковом формате, как например сделано тут: https://github.com/yandex-ui/noscript/blob/master/doc/ns.view.md ?

[edoroshenko]

Кстати, а давайте ещё делать всё в gist'ах, как у @Lapple , чтобы можно было обсуждать удобно?

[doochik]

А почему нельзя обсуждать в комментах или pr?

[edoroshenko]

pr - тоже вариант. Давайте тогда все делать pr?

[chestozo]

pr рулит

[Lapple]

Да уж лучше PR, там оказывается комментов к гисту написали, а мне отбивки не пришли автоматом.

[edoroshenko]

Встречайте, поэтапная инициализация модели! https://github.com/yandex-ui/noscript/pull/247

[doochik]

Дописал что знаю про коллекции https://github.com/yandex-ui/noscript/pull/254

[chestozo]

Я вот понял, что хочется onepage документашку. Как тут http://sweetjs.org/doc/main/sweet.html или тут http://nodejs.org/api/all.html

[doochik]

Если ты найдешь генератор такой документации из .md файлов, будет круто

[chestozo]

Я тут подглядел немного, как в ноде генерится дока (у них тоже markdown на входе). Глубоко не копал пока, но можно попробовать заюзать их тулзы https://github.com/joyent/node/blob/master/Makefile#L187-L188

[chestozo]

Что-то такое можно сгенерить ) http://chestozo.github.io/doc/api/all.html

[bt4R9]

+1 single page doc, то что нужно

[chestozo]

@edoroshenko, что думаешь?

[edoroshenko]

:+1:

[chestozo]

Ок, постараюсь собрать в ближайшее время.

[chestozo]

Тут буду пилить #330