منصوبے کے بارے میں

Folio کو ایک Markdown فارمیٹ اور ٹولز کے مجموعے کے طور پر پیش کیا گیا ہے تاکہ ایک ایسے پروگرام کو دستاویز کے اندر لکھا جا سکے جو اس کی وضاحت بھی کرے۔ ایک دستاویز YAML ہیڈر سے شروع ہو سکتی ہے جس میں format، id، type، status، اور tangle root جیسے فیلڈز شامل ہوتے ہیں۔ کوڈ بلاکس کو نام دیا جا سکتا ہے اور ان کے لیے ٹارگٹ فائل کی وضاحت کی جا سکتی ہے۔ Tangling عمل دستاویز کے کوڈ بلاکس کو سورس فائلوں میں جمع کرتا ہے، ہر فائل کے کمنٹ اسٹائل میں ایک جنریٹڈ ہیڈر لکھتا ہے، اور ایک tangle-map سائیڈ کار ریکارڈ کرتا ہے جو ظاہر کرتا ہے کہ کس چنک نے کون سی فائل تیار کی۔ چنکس کو ایک لائن پر بلاک ریفرنس رکھ کر اور اس بلاک کو ریفرنس کی انڈنٹیشن پر پیسٹ کر کے splice کیا جا سکتا ہے۔ Weaving اسی دستاویز کو پڑھنے کے لیے ایک صفحے کے طور پر رینڈر کرتا ہے۔ Checker دستاویز کے میٹا ڈیٹا کی تصدیق فراہم کردہ وکیبلری یا دستاویزات میں بیان کردہ وکیبلری کے مطابق کرتا ہے۔ فراہم کردہ وکیبلری دستاویزات، سافٹ ویئر اور ان کے تعلقات کی وضاحت کرتی ہے، اور اسے وسعت دی جا سکتی ہے یا تبدیل کیا جا سکتا ہے۔ دستاویزات Turtle یا YAML بلاکس کا استعمال کرتے ہوئے concepts اور instances کا اعلان کر سکتی ہیں۔ Publications ایک بڑے مجموعے سے دستاویزات اور کوڈ کا انتخاب کرتے ہیں اور ایک اسٹینڈ الون ریپوزٹری تیار کرتے ہیں، جس کے ذرائع PROVENANCE.json میں ریکارڈ کیے جاتے ہیں اور منتخب کردہ مواد سے باہر کے crates پر انحصار سے گریز کیا جاتا ہے۔ یہ ریپوزٹری اسی طریقے سے تیار کی گئی ہے اور اس میں ٹول کے ساتھ ساتھ وہ سورس دستاویزات بھی شامل ہیں جنہوں نے اسے جنریٹ کیا۔ جنریٹ شدہ Rust کو کمٹ کیا گیا ہے، لہذا ایک تازہ کلون کو cargo کے ذریعے بلڈ کیا جا سکتا ہے۔ گائیڈز انٹیگریشن، دستاویزات کو موجودہ کوڈ سے جوڑنے، اور موجودہ حدود کا احاطہ کرتی ہیں۔ CI دوبارہ tangle کر سکتا ہے اور اگر ٹری تبدیل ہو جائے تو ناکام ہو سکتا ہے۔ لائسنس MIT ہے، اور ڈیپینڈینسی لائسنس اپنی شرائط برقرار رکھتے ہیں۔ README ایک ایجنٹ سے یہ پوچھنے کے لیے ایک مثال پرامپٹ بھی فراہم کرتا ہے کہ Folio کسی پروجیکٹ میں کہاں مدد کر سکتا ہے۔