starknet docs
v0.1.514
Starknet DocsのWebサイトhttps://docs.starknet.ioは、Asciidocで作成され、Asciidocの静的WebサイトジェネレーターであるAntoraを使用して構築されています。
StarkNetの技術文書に貢献することに興味がある場合、次の表は、開始を支援するための簡単なリンクを提供します。
質問 | リソース |
私は興味があります、どうすれば貢献できますか？ | 貢献方法については、さまざまな貢献方法をご覧ください。 |
私を助けるための基本的なガイドラインはありますか？ | コンテンツを一貫性に保つのに役立つ基本的なガイドラインについては、ドキュメントガイドラインを参照してください。 |
使用すべきスタイルガイドとライティングガイドはありますか？ | StarkNetドキュメント補足スタイルガイドを参照してください。 |
ワークステーションをセットアップするにはどうすればよいですか？ | 環境のセットアップを参照してください。 |
StarkNetドキュメントに貢献できるいくつかの異なる方法があります。
githubの問題を作成します。
プルリクエスト（PR）を送信します。 StarkNet-Docsリポジトリの独自のフォークのローカルクローンを作成し、変更を加え、PRを送信できます。このオプションは、かなりの変更がある場合、または追加したい変更をより迅速に支援する場合に最適です。
PRを提出するとどうなりますか？
PRを提出すると、StarkNet DocsチームがPRをレビューし、必要に応じてさらに技術的なレビューを配置します。 PRが変更を必要とする場合、レビュアーはPRにコメントを追加します。変更を行うことを要求するか、コンテンツを別のPRに組み込んだことをお知らせする場合があります。時折、元のPRに直接コミットを追加することがあります。 PRがレビューされ、すべての更新が完了すると、ドキュメントチームがPRをマージし、有効なバージョンに適用します。
StarkNetドキュメント補足スタイルガイド：一般スタイルのガイダンスとライティングガイダンス。
Asciidocでの執筆に関する詳細については、次を参照してください。
Asciidoc言語ドキュメント
ASCIIDOC構文クイックリファレンス
注記 | ID、ソースコードブロック、相互参照、およびリンクをコーディングする方法は複数あります。一般に、コードの読みやすさに優先順位を付けるために、コーディングに最も明示的なコーディング規則を使用します。これらのコーディング規則のほとんどは、Red HatドキュメントのAsciidocマークアップクイックリファレンスにリストされています |
まだインストールされていない場合はyarnをインストールします。
まだインストールされていない場合はnpxをインストールします。
フォークから、またはあなたが公式の協力者である場合は、 starknet-io/starknet-docsから直接このリポジトリをクローンします。
starknet-docsディレクトリに変更します。
yarnコマンドを実行して環境を準備します。
糸
yarn package-lock.jsonとpackage.jsonに基づいて必要なモジュールをインストールして、環境を準備する必要があります。成功した場合は、コンテンツを構築およびプレビューできるはずです。
コンテンツを作成または編集した後、変更をプレビューするには：
build_local_site.sh buildスクリプトを実行してコンテンツを作成します。
./build_local_site.shこのコマンドは、ディレクトリpublic_htmlでWebサイトを生成します。
次のいずれかを実行してウェブサイトを開きます。
開始ページを開きます： <repo_root>/public_html/index.html 。
Antoraでパッケージ化されたHTTPサーバーを実行します。
npx http-server public_html -c-1サーバーは実行され、ウェブサイトを表示するために使用できる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このリポジトリのドキュメントの変更をリリースするための高レベルのプロセス。
コンテンツ開発の過程で、作家は、必要に応じて、これらの変更をリリースする準備ができるまで待機する、docs.starknet.ioにそれらを投稿するまで、これらの変更を必要に応じて直接mainに直接変更するかの変更とブランチを統合します。
githubアクションリポジトリのリリースとタグページに表示されるGitタグとリリースを作成します。
機能ブランチがmainブランチに統合されると、GitHubアクションはフォーマットv<version>.<major_update>.<minor_update>でリリースタグを作成し、 CHANGELOG.mdを更新します。次に、新しいコンテンツをdocs.starknet.ioに公開します。
mainに機能ブランチをマージすると、機能ブランチに変更が自動的に公開されます。追加の手順は必要ありません。
githubは、 package.jsonとpackage-lock.jsonのバージョン番号を増分し、 mainに統合された各PRの説明でCHANGELOG.mdを更新します。 。次のいずれかを使用して、リモートmainブランチから地元のmainブランチを更新してください。
変更を引く：
starknet-docs (main) git pull [email protected]:starknet-io/starknet-docs.git ：
starknet-docs (main) git fetch origin
starknet-docs (main) git rebase origin/main注記 | フォークを使用している場合、フォークされたレポはデフォルトで |
