content icon indicating copy to clipboard operation
content copied to clipboard

Обновление инструкции для контрибьюторов

Open solarrust opened this issue 1 year ago • 2 comments

  1. Выпилить команду проверки орфографии. Позже заменить на актуальную.
  2. Выпилить Докер из предпросмотра. UPD: или не выпиливать, а просто оставить как самый последний способ запустить проект локально. Для Windows апдейтнуть команды и указать, что работает только с WSL.
  3. Акцентировать внимание на том, что можно смело юзать чистый Маркдаун.
  4. Упростить тексты.
  5. Очень много ссылок разбросано по текстам инструкций. Уменьшить бы, собрать в одном месте, возможно.
  6. Сложная организация инструкций. Часть хранится в платформе, часть — в контенте. Из-за этого по ним сложно ориентироваться. ❓ Отдельное репо для инструкций, в ридми контента и платформы оставить только самое главное и дать ссылку на репо с инструкциями ❓
  7. Разбавить тексты схемами (и, возможно, иллюстрациями).
  8. Решать проблемы также автоматически, а не через инструкции. К примеру, создание папки автора.

Организация инструкций сейчас

platform
  README.md
  ⊤ docs
    README.md
    deploy.md
    deps.md
    how-its-work.md
    how-to-run.md
    license.md
    load-fix.md
content
  README.md
  ⊤ docs
    ⊤ demos
       ⊢ images
       index.md
       style.md
    ⊤ examples
      article.md
      doka.md
    ⊢ images
    README.md
    api.md
    contributing.md
    interviews.md
    license.md
    load-fix.md
    people.md
    practice.md
    preview.md
    schemes.md
    speller.md
    styleguide.md

solarrust avatar Apr 18 '24 18:04 solarrust