ฐานโค้ดเป็น Shadow docs
Code Base ในรูปแบบ Shadow Docs คืออะไร
เมื่อคุณซิงก์รีโพ GitHub ไปยัง Space ใน Archbee คุณสามารถนำ Code base ของคุณเข้าไปใน Space นั้นเป็น Shadow Docs ได้ เยี่ยมชม Shadow docs เพื่อเรียนรู้เพิ่มเติม
ซึ่งหมายความว่า ระบบ AI จะทำการจัดทำดัชนีโค้ดทั้งหมดที่คุณกำหนดให้ซิงก์และจะใช้ข้อมูลนั้นฝึก ผู้ช่วยถามตอบ AI ด้วย code base ที่ให้ไว้
ทุกเอกสารที่ถูกเพิ่มเข้าไปในโฟลเดอร์ Shadow Docs จะ ไม่ปรากฏให้เห็น บนพอร์ทัลที่เผยแพร่ ไม่ว่าจะสำหรับลูกค้าหรือผู้ใช้ภายในของคุณ โค้ดที่ให้ผ่าน Shadow Docs จะถูกใช้เพื่อฝึก AI ของคุณและช่วยตอบคำถามเกี่ยวกับโค้ดของคุณสำหรับผู้ใช้
ฉันจะใช้งานมันได้อย่างไร?
นี่คือกรณีการใช้งานที่พบบ่อยที่สุด 2 รูปแบบ:
- ซิงก์โค้ดเบสของแอปของคุณไปยัง Archbee Space เผยแพร่พอร์ทัลภายใน (ป้องกัน ไม่สาธารณะ) สำหรับทีมเทคนิคและไม่ใช่เทคนิคของคุณ พอร์ทัลนี้ซึ่งขับเคลื่อนด้วย AI ของเรา จะสามารถตอบคำถามและแนะนำวิธีการทำการปรับปรุงต่างๆ การผสานรวม การเพิ่มประสิทธิภาพ ฯลฯ ตามโค้ดเบสของคุณ
- ซิงก์โค้ดเบสของแอปของคุณไปยัง Archbee Space เผยแพร่พอร์ทัลสาธารณะสำหรับผู้ใช้ของคุณ ที่นี่ผู้ใช้ของคุณจะสามารถรับคำตอบโดยตรงเกี่ยวกับวิธีใช้แอปของคุณ API SDK ไลบรารี ฯลฯ
วิธีการกำหนดค่า
ก่อนอื่นคุณต้องตั้งค่าการเชื่อมต่อ GitHubตามที่อธิบายไว้ที่นี่
จากนั้นคุณต้องตั้งค่า repository
ในไฟล์ archbee.yaml คุณต้องตั้งค่าshadowDocsด้วยเส้นทางของ code base ที่คุณต้องการ sync กับ Archbee
# This will include all code files from your repo
shadowDocs:
- "*"# This will include only the index.ts code file
shadowDocs:
- "init/index.ts"
# To also include documentation files from docs folder
root: docsนี่คือสิ่งที่คุณจะเห็นหลังจากนำเข้า
ตรวจสอบให้แน่ใจว่าคุณเปิดใช้งานAI Addonในหน้า Organisation Settings แล้ว
สรุป
- ไฟล์โค้ดทั้งหมดที่ซิงก์ผ่าน Shadow Docs จะไม่ถูกเปิดเผยต่อสาธารณะไม่ว่าในเวลาใด
- จุดประสงค์ทั้งหมดคือเพื่อให้บริบทกับ AI ของเรา เพื่อให้สามารถตอบคำถามด้านเทคนิคและให้คำแนะนำทางเทคนิคแก่ผู้ใช้ภายในหรือผู้ใช้สาธารณะของคุณได้