После того как я поработал вчера не с этим репозиторием а с нашим сайтом документации я понял что будет круто если мы создадим индекс всех подмодулей, которые учавствуют в этом проекте.
мы несколько раз начинали это делать, поэтому у нас есть много заготовок, которые после того как мы все отформатируют будут выглядеть как репозиторий awesome-email-marketing.
проблема: в нашем проекте есть много движущихся частей. я их называю модули. если над модулем не работать пару месяцев - сразу забывается зачем он был создан. Плюс, если появятся новые люди на проекте - они вообще не поймут вначале, что именно происходит.
Мы перенесли контент из .github в https://github.com/LLazyEmail/documentation/blob/main/docs/generator/test/LLazyEmail%20Documentation.md
Часть похожих действий мы сделали для раздела React Design System. Мы перенесли в него список репозиториев, работающих с реактом, мы также добавили туда секцию remix-* репозиториев, ссылки на темплейты и т.д.
Но и этого варианта тоже недостаточно, потому что основным пользователем сайта документации буду не я а другие люди, поэтому мы потратим какое то время и улучшим тот файл тоже.
Что нужно сделать:
- создать новый документ, который будет привязан к этой задаче, можно назвать его Modules-Index.md
- скопировать в него текущий контент, который находился у нас в файле LLazyEmail Documentation. Из этого документа нас интересуют только списки с модулями, статьи и т.д. нам ненужны.
- для каждого модуля, мы применяем новый темлейт, который я вставил ниже. Часть данных вы сможете закинуть, а часть данных я добавлю потом сам.
- мы сделаем несколько циклов, перед тем как мы сможем считать эту задачу готовой.
Question: should it be long, or with a list of subpages?
template:
**Name**: ...
**Link**:...
**Description**: <>
**Status**: not finished
**Need Help**: Yes
We will also create an index of react-only repositories too.
Note: похожие шаги можно/нужно сделать и для нашего раздела react design(но в отдельном файле пока) - https://llazyemail.github.io/documentation/docs/React-Design-System
После того как я поработал вчера не с этим репозиторием а с нашим сайтом документации я понял что будет круто если мы создадим индекс всех подмодулей, которые учавствуют в этом проекте.
мы несколько раз начинали это делать, поэтому у нас есть много заготовок, которые после того как мы все отформатируют будут выглядеть как репозиторий awesome-email-marketing.
проблема: в нашем проекте есть много движущихся частей. я их называю модули. если над модулем не работать пару месяцев - сразу забывается зачем он был создан. Плюс, если появятся новые люди на проекте - они вообще не поймут вначале, что именно происходит.
Мы перенесли контент из
.githubв https://github.com/LLazyEmail/documentation/blob/main/docs/generator/test/LLazyEmail%20Documentation.mdЧасть похожих действий мы сделали для раздела React Design System. Мы перенесли в него список репозиториев, работающих с реактом, мы также добавили туда секцию remix-* репозиториев, ссылки на темплейты и т.д.
Но и этого варианта тоже недостаточно, потому что основным пользователем сайта документации буду не я а другие люди, поэтому мы потратим какое то время и улучшим тот файл тоже.
Что нужно сделать:
Question: should it be long, or with a list of subpages?
template:
We will also create an index of react-only repositories too.
Note: похожие шаги можно/нужно сделать и для нашего раздела react design(но в отдельном файле пока) - https://llazyemail.github.io/documentation/docs/React-Design-System