קריאת תיעוד המאגר ישירות באפליקציה

מה זה
סייר המסמכים (Docs explorer) הוא מציג מקורי עבור קובצי ה-markdown של המאגר שלכם. הוא ממוקם תחת „עזרה“ בסרגל הצד השמאלי ומציג קובצי readme, מפרטים וקובצי .md אחרים ישירות בתוך האפליקציה.
למה להשתמש בזה
הוא מייתר את הצורך לצאת מסביבת העבודה שלכם או לעבור למקור חיצוני כמו GitHub כדי לקרוא את תיעוד הפרויקט. כל הקבצים מוצגים בערכת הנושא המקורית של האפליקציה.
איך להשתמש בזה
לחצו על סמל מסמכים. במסכים רחבים, הסייר נפתח בשני חלונות: עץ תיקיות אינטראקטיבי משמאל ומציג המסמכים מימין. תוכלו להרחיב תיקיות כדי למצוא מסמכים או ללחוץ על קישורים בתוך המסמכים כדי לנווט. בטלפון נייד מוצגת עמודה בודדת עם כפתור „תיקיות“ לפתיחת הסייר מעל המסמך. ניתן לשתף קישורים בקלות מכיוון שכתובות ה-URL בנויות במבנה /docs/<repo path>.
הדרך הישנה
בעבר, משתמשים נאלצו לגשת למארח המאגר החיצוני או לקרוא קובצי markdown גולמיים באופן מקומי כדי לצפות בתיעוד הפרויקט.
הדרך החדשה
כעת המסמכים מפוענחים ומוצגים בצורה ברורה ישירות בתוך סביבת העבודה. המציג תומך בניתוב יחסי עבור קישורים בין קבצים ושומר על המיקום שלכם באופן אינטואיטיבי.