andocs

Andocs の執筆

Andocs の紹介やローカルデモを行う場合は、紹介フローに従ってください。そのガイドに記載されている公開済み CLI コマンドで、ローカルプレビューを開始してください。

その他の編集作業では、編集する前に、依頼内容またはリポジトリからドキュメントのルートを確認してください。複数のルートが候補として残る場合は、どれを使用するか確認してください。リポジトリの言語とプレビューのルールに従ってください。

作業内容に合ったリファレンスを読んでください。

• Markdown のレンダリング — 図、数式、インタラクティブな html-preview ブロック、または Andocs 固有のリンクを記述するときに読んでください。
• プロトタイプ — prototype.json、HTML ページ、ページ間のナビゲーション、相対パスで指定する静的ファイル、共有アセット、または prototype ブロックを作成・編集するときに読んでください。
• レビュー状況とリリース — プロトタイプで画面レビュー用バッジ、releases.json、または <id>@<release>.html の画面バリアントを使用するときに読んでください。
• プロトタイプの状態 — プロトタイプのデータを更新後も保持する必要がある場合や、既存の状態を持つプロトタイプを移行する場合に読んでください。
• Web コンポーネント — プロトタイプでカスタム要素または Shadow DOM を使用するときに読んでください。
• OpenDesign への引き継ぎ — ユーザーから Andocs のプロトタイプを OpenDesign で編集するよう依頼された場合、またはソースから OpenDesign を準備するよう依頼された場合に読んでください。

ローカルプレビューを依頼された場合は、ドキュメントのルートを確認し、Bun が利用可能であることを確かめてください。サーバーの起動がユーザーとリポジトリの指示によって許可されている場合に限り、bunx andocs@latest serve --path <docs-root> を使用してください。CLI のヘルプは bunx andocs@latest -h です。

作業を終える前に、参照されているファイルが存在すること、フェンス付きコードブロックに適切な言語が指定されていること、プロトタイプの状態がストレージを利用できない場合に対応していることを確認してください。公開されている Andocs デモでは、完全なプロトタイプリポジトリを確認できます。