starknet docs

Старкнет документация хранилище

Веб -сайт Docs Starknet, https://docs.starknet.io, написан в Asciidoc и построен с использованием Antora, статического генератора веб -сайтов для Asciidoc.

Вклад в документацию Starknet

Если вы заинтересованы в участии в технической документации Starknet, в следующей таблице предоставлены быстрые ссылки, которые помогут вам начать.

Вопрос	Ресурс
Мне интересно, как мне внести свой вклад?	Для получения информации о том, как вы можете внести свой вклад, см. Различные способы внесения вклад.
Есть ли основные рекомендации, которые помогут мне?	Основные руководящие принципы, которые помогут нам поддерживать наш Контент в соответствии, см. Руководство по документации.
Есть ли руководство по стилю и письменное руководство, которое я должен использовать?	См. Руководство по документации Starknet Дополнительное стиль.
Как настроить свою рабочую станцию?	Смотрите настройку вашей среды.

Разные способы внести свой вклад

Есть несколько разных способов внести свой вклад в документацию Starknet:

• Создайте проблему GitHub.

• Отправьте запрос на вытяжение (PR). Вы можете создать локальный клон, собственный вил, репозитория Starknet-Docs, внести свои изменения и отправить PR. Этот вариант лучше всего, если у вас есть существенные изменения или помогать изменениям, которые вы хотите добавить быстрее.

Что происходит, когда вы отправляете PR?

Когда вы отправляете PR, команда Docs Starknet рассматривает PR и при необходимости организует дополнительные технические обзоры. Если PR требует изменений, рецензенты добавляют комментарии к PR. Мы могли бы попросить вас внести изменения, или сообщить вам, что мы включили ваш контент в другой PR. Иногда мы могли бы добавить коммиты к оригинальному PR напрямую. Когда PR был рассмотрен и все обновления завершены, команда документов объединяет PR и применяет его к действительной версии.

Советы по авторизации

• Руководство по документированию Starknet Дополнительное стиль: Руководство по общему стилю и руководство по письму.

Для получения информации о письме в Asciidoc см.

• Языковая документация Asciidoc

• Asciidoc syntax Quick reference

Примечание

Существует несколько способов кодирования идентификаторов, блоков исходного кода, перекрестных ссылок и ссылок. В целом мы используем наиболее явные соглашения о кодировании для кодирования, чтобы определить приоритет читабельности кода. Большинство из этих соглашений о кодировании перечислены в asciidoc charge Quick replaricht для документации Red Hat

Прежде чем начать

1. Установите yarn , если она еще не установлена.

2. Установите npx , если он еще не установлен.

3. Клонируйте это репо, либо из вилки, либо, если вы официальный сотрудник, то непосредственно из starknet-io/starknet-docs .

4. Изменить в каталог starknet-docs .

5. Запустите команду yarn , чтобы подготовить окружающую среду:

    пряжа

yarn должна подготовить вашу среду, установив необходимые модули на основе package-lock.json и package.json . Если он был успешным, вы сможете создавать и предварительно просмотреть контент.

Создание и предварительное просмотр контента локально

После написания или редактирования контента, для просмотра ваших изменений:

1. Создайте контент, запустив сценарий build_local_site.sh сборка:

   ./build_local_site.sh

   Эта команда генерирует веб -сайт в Directory public_html .

2. Откройте веб -сайт, выполнив одно из следующих действий:

   • Откройте страницу старта: <repo_root>/public_html/index.html .

   • Запустите HTTP -сервер, упакованный с Antora:

     npx http-server public_html -c-1

     Сервер работает и дает вам один или несколько локальных URL -адресов, которые вы можете использовать для просмотра веб -сайта. Например:

     Starting up http-server, serving public_html
     
     ...
     
     Available on:
       http://127.0.0.1:8080
       http://192.168.68.111:8080
       http://192.168.14.3:8080
       http://10.14.0.2:8080
     Hit CTRL-C to stop the server

Выпуск документов Starknet на GitHub (только для администраторов)

Высокий процесс выпуска изменения документации в этом репозитории.

В ходе разработки контента писатели объединяют ветви с изменениями либо непосредственно в main , во вторичную ветвь по мере необходимости, где эти изменения ждут, пока мы не будем готовы их освободить, то есть опубликовать их на docs.starknet.io.

Действия GitHub создают теги и выпуски GIT, которые появляются на страницах репо и тегов.

Когда ветвь функции объединяется CHANGELOG.md main ветвь, действие GitHub создает тег выпуска в формате v<version>.<major_update>.<minor_update> Затем он публикует новый контент в docs.starknet.io.

Процедура

Объединение филиала функции для main автоматически публикует изменения в филиале функций. Никаких дополнительных шагов не требуется.

GitHub увеличивает номера версий в package.json и package-lock.json и обновляет CHANGELOG.md с описаниями каждого PR, который был просто объединен в main . Полем Обновите свою локальную main ветвь от удаленной main ветви, используя одно из следующих действий:

• Вытяните изменения:

  starknet-docs (main) git pull

• Сделайте Rebase с [email protected]:starknet-io/starknet-docs.git :

  starknet-docs (main) git fetch origin
  starknet-docs (main) git rebase origin/main

  Примечание

  Если вы используете вилку, то ваша раздвоенная репо является origin по умолчанию, и в этом случае вам следует назначить имя upstream по адресу [email protected]:starknet-io/starknet-docs.git . Поэтому при перетасовке используйте upstream вместо origin в вышеуказанных командах.