spool-hubBlog

Read Repository Documentation in the App

newsa-686

A sleek digital library and documentation explorer, abstract representation with neat folders and text documents

What it is

The Docs explorer is a native viewer for your repository's markdown files. Located under Help on the left rail, it renders readmes, specifications, and other .md files directly in the app.

Why use it

It eliminates the need to leave your workspace or go to an external source like GitHub to read project documentation. All files are rendered in the app's native theme.

How to use it

Click the Docs icon. On wide screens, the explorer opens in two panes: an interactive folder tree on the left and the document viewer on the right. You can expand folders to find documents or click links inside documents to navigate. On a phone, you see a single column with a 'Folders' button to toggle the explorer above the document. You can easily share links since URLs follow the /docs/<repo path> structure.

The old way

Previously, users had to navigate to the external repository host or read raw markdown files locally to view project documentation.

The new way

Documents are now parsed and rendered beautifully within the workspace. The viewer supports relative routing for links between files and maintains your position intuitively.