x0k-folio

Folioは、プログラムを説明するドキュメント内にプログラムを記述するためのMarkdown形式およびツールセットとして提示されています。ドキュメントは、format、id、type、status、tangle rootなどのフィールドを持つYAMLヘッダーで開始できます。コードブロックには名前を付け、ターゲットファイルを指定することが可能です。Tanglingは、ドキュメントのコードブロックをソースファイルに収集し、各ファイルのコメントスタイルで生成されたヘッダーを書き込み、どのチャンクがどのファイルを生成したかを示すtangle-mapサイドカーを記録します。チャンクは、ブロック参照を一行に配置し、その参照のインデント位置にそのブロックを貼り付けることでスプライスできます。Weavingは、同じドキュメントを閲覧用のページとしてレンダリングします。チェッカーは、提供された語彙またはドキュメント内で定義された語彙に基づいてドキュメントのメタデータを検証します。提供される語彙は、ドキュメント、ソフトウェア、およびそれらの関係を記述し、拡張または置換が可能です。ドキュメントは、TurtleまたはYAMLブロックを使用してコンセプトとインスタンスを宣言できます。Publicationsは、大規模なコレクションからドキュメントとコードを選択し、独立したリポジトリを生成します。その際、オリジンはPROVENANCE.jsonに記録され、選択範囲外のcratesへの依存は拒否されます。本リポジトリはこの方法で作成されており、ツールとそれを生成したソースドキュメントが含まれています。生成されたRustはコミットされているため、新規クローン後もcargoでビルド可能です。ガイドでは、統合、既存コードへのドキュメントの紐付け、および現在の制限事項について説明しています。CIは再tanglingを行い、ツリーに変更があった場合に失敗させることができます。ライセンスはMITであり、依存ライセンスはそれぞれの条件を維持します。また、READMEには、プロジェクトのどこでFolioが役立つかをエージェントに評価させるためのプロンプト例が記載されています。