ガイドを編集する#

CompNode Guideの本文は、CompNodeAEのprivateリポジトリにあるMarkdownファイルです。編集にはそのリポジトリへのアクセス権が必要です。公開サイトを読むだけならGitHubへのログインは不要です。

開いているページを編集する#

ページの本文の下にある「このページを編集」を押すと、GitHubでそのページの原稿が開きます。本文を直して「Commit changes」でmainに保存すると、CompNode Guideの自動チェックが始まります。別のブランチに保存した場合は、Pull Requestをmainへ取り込んだ時点で公開が始まります。

自動チェックが成功すると、公開サイトが更新されます。チェックに失敗した場合、公開中の正常な版を維持します。 Cloudflareのダッシュボードの「Workers & Pages → compnodeae」で進行状況と失敗した項目を確認できます。保存してから反映まで少し時間がかかります。 GitHubのコミットに付くCloudflareのチェックからも結果を開けます。

GitHubから編集する#

本文のフォルダーを開き、編集したい.mdファイルを選んで鉛筆ボタンを押します。

編集したい内容	ファイル
トップページ	index.md
インストール手順	getting-started/install.md
動画を扱う手順	how-to/process-video-frames.md
操作方法	reference/interactions.md
型の説明	reference/types/
CNLの説明	cnl/
ノード一覧・各ノードの用途説明	node-guides.json

原稿の書き方#

各ページのタイトルは#一つで書き、ページ内に一つだけ置きます。節には##、項目には-を使えます。リンク先はほかの原稿への相対パスで指定します。

# ページのタイトル

ここに説明を書きます。

## 操作手順

1. 最初の操作を行います。
2. 次の操作を行います。

[型の説明](../reference/types.md)も参照してください。

リンク切れ、存在しない見出し、壊れた数式、ノードの参照情報の不整合は公開前に検出します。ページ上部のproduct-docという注釈がある場合、状態を本文と一致させてください。

自動生成される参照ページ#

各ノードの入出力・Operation・初期値は、検証した配布版の実装から取り出した参照情報で生成します。これらのページの「このノードの説明を編集」は、用途説明を管理するnode-guides.jsonを開きます。生成されたHTMLを編集する必要はありません。入出力の仕様変更はプラグイン本体の実装・検証を伴います。

テスター規約はZIPの利用条件と同じ内容に保ちます。規約を変更するときは getting-started/tester-license.mdとlicensing/DISTRIBUTE_JA.mdの本文を一緒に更新してください。サイトの自動更新では、プラグインのZIPと個別ライセンスキーは更新・公開されません。