عن المشروع

يُقدم Folio كتنسيق Markdown ومجموعة من الأدوات لكتابة برنامج داخل المستند الذي يشرحه. يمكن أن يبدأ المستند بترويسة YAML تحتوي على حقول مثل format و id و type و status و tangle root. يمكن تسمية كتل الكود وتحديد ملف مستهدف لها. تقوم عملية Tangling بجمع كتل الكود من المستند في ملفات مصدر، وكتابة ترويسة مُنشأة بأسلوب التعليقات الخاص بكل ملف، وتسجيل ملف جانبي (tangle-map) يوضح أي جزء أنتج أي ملف. يمكن دمج الأجزاء عن طريق وضع مرجع للكتلة في سطر ما، ولصق تلك الكتلة عند مستوى إزاحة المرجع. أما عملية Weaving فتقوم بتصيير المستند نفسه كصفحة للقراءة. ويقوم الـ checker بالتحقق من صحة البيانات الوصفية للمستند مقابل مفردات مُقدمة أو محددة داخل المستندات. تصف المفردات المقدمة المستندات والبرمجيات والعلاقات بينها، ويمكن توسيعها أو استبدالها. يمكن للمستندات التصريح عن المفاهيم والنماذج باستخدام كتل Turtle أو YAML. تختار المنشورات (Publications) مستندات وأكواد من مجموعة أكبر وتنتج مستودعاً مستقلاً، مع تسجيل الأصول في ملف PROVENANCE.json ورفض التبعيات على crates خارج نطاق الاختيار. لقد تم إنتاج هذا المستودع بهذه الطريقة وهو يتضمن الأداة بالإضافة إلى المستندات المصدرية التي أنشأتها. يتم تثبيت كود Rust المُنشأ، لذا يمكن بناء نسخة مستنسخة جديدة باستخدام cargo. تغطي الأدلة التكامل، وتوجيه المستندات نحو كود موجود، والقيود الحالية. يمكن لـ CI إعادة عملية tangle والفشل إذا تغيرت الشجرة. الترخيص هو MIT، وتحتفظ تراخيص التبعيات بشروطها الخاصة. يقدم ملف README أيضاً مثالاً لمطالبة (prompt) لسؤال وكيل ذكاء اصطناعي لتقييم المجالات التي يمكن لـ Folio المساعدة فيها داخل المشروع.