mam_mol
mam_mol copied to clipboard
hyoo-ru
Создать удобную документацию
- [ ] Продумать иерархию документации
- [ ] На сайте mol.js.org добавить раздел
- [x] Примеры и демки упрятать в раздел
- [ ] Добавить систему тегов и выстроить по ней иерархию
а зачем теги? Их всегда или забывают ставить, или ставить корректно, или называют так, что кроме одной сущности ничего не подцепишь. Тем более в документации. Теги подразумевают что документация ад.
Вопрос можно поставить так.: можно ли сделать модульную документацию удобочитаемой и полезной? Например, собирать меню по тегам. Или ручками все правки?
Теги нужны для нечёткого поиска. Например, пользователь ищет "dropdown" - надо показать $mol_pop, $mol_select, $mol_search.
предлагаю сделать туториал как у свелт (https://svelte.dev/tutorial/basics), объясняя каждый аспект, потому что это база, надо хотябы основу сделать более подробно
Нужен маппинг от концепций популярных фреймворков в концепции $mol. Реакта/ангуляра достаточно. Как пример:
- Динамическое скрытие/показ по условию (*ngIf)
- Рендеринг списков (*ngFor)
- Input/Output/пропсы
- Подписки на события
- Хуки жизненного цикла??
- Http
- Роутинг
- Стейт менеджмент/сервисы Отдельно стоит пройтись по синтаксису tree с понятными примерами на тему ЧТО и ЗАЧЕМ. Например event * ^ Имеет смысл использовать только для наследуемых компонентов, а не для любых...
Туториал аля свелте это неплохо, но без интеллисенса в tree это дохлый номер. А чтобы завести его туда, надо завести его хотя бы во фреймворк..)
Описание методом аналогий отберет много ресурсов и не поможет тем, кто плохо знает попсовые фронтенд-фреймворки (к примеру, бэки, которые хотят быстро во фронт из коробки). Некоторые вещи, в mol в принципе отсутствуют и не нужны, как хуки.
Полезнее формулировать задачи в бизнес-терминах, как сделать то-то. Лучше вот такой список задач и сформулировать.
@zerkalica я не совсем соглашусь. Не ссылаться на аналогии или концепции попсовых фреймворков - отрезать эту аудиторию, и заклеймиться самыми умными, не считающими нужным снизайти до земного мира. Какие-то связи нужны - это уважение к другому опыту. Первым делом я нырну туда, где мне покажут аналогии с текущим опытом чтобы обьяснить различия и новые концепции.
В доках можно показать упрощеную реализацию основных модулей(atom, view, еще что-то?) и написать на них какую-нибудь тудушку
Я думаю должен быть кукбук как для новичков во фронтенде, так и для имеющих некоторых бэкграунд. Можно сделать как в каком-нибудь Dragon Age Origins, где у каждого персонажа приключение начинается со своей локации и своими стартовыми квестами, но ко второй главе все эти линии сливаются в один основной квест. То есть можно на старте дать людям возможность выбрать свой бэкграунд типа "я реактовод", "я джейкуерист" или "я вообще бэк". Далее каждому из них подаётся базис для выравнивания понятий с учётом их бэкграунда. А потом уже общая для всех часть как зная базис делать разные штуки.
Я считаю ошибкой использование не уникального графического контента. Это говорит о том что продукт не самодостаточен. Лучше вообще не привлекать графику в этом случае, чем заимствовать даже со свободной лицензией. А с кукбуком и схемой согласен.
Дополню по улучшеню базовой документации: https://github.com/hyoo-ru/mam_mol/discussions/511 https://github.com/hyoo-ru/mam_mol/discussions/512
