Features

Tree View #

The Docs as Code extension now has a tree view that allows you to access all of the articles and commands from the sidebar. Buttons at the top of the sidebar allow you to fetch the latest version of the documentation repository, run the documentation site locally to preview your articles, or import a Word document as a new article. The tree view is divided into three sections:

My Working Articles

This section displays all of the articles that you are currently working on. This section will be empty if you are not currently working on any articles.

Awaiting Review

This section displays all of the articles that have been created or revised and requested by the author or editor to be reviewed. This section will be empty if there are no articles awaiting review.

All Articles

This section displays all of the articles in the DocsAsCode repository. Buttons are provided to allow you to create new articles and folders inside of any existing folder. Right clicking on an article or folder will provide you with the option to delete or rename the article or folder. Dragging and dropping an article or folder will allow you to move the article or folder to a different folder.

Local Site Preview #

The internal documentation site can be run locally by clicking the 'Run Site Locally' button in the tree view. This will start a local server and open the documentation site in your default browser. The site will open to the currently open article. The documentation site will automatically refresh when you save changes to an article.

Peer Reviews #

Users can request a peer review upon submission of a new or revised article. The article will be moved to the 'Awaiting Review' section of the tree view and an email template requesting the review of the given article (including a link to open the article) will be generated for the user to send to their choice of reviewer(s). Reviewers can open the article from the email and leave comments on the article. Once the reviewer has finished reviewing the article, they can submit the review back to the author, recommending additional changes or publication.

Word Document Import #

By clicking the 'Upload .docx File' button in the tree view, you can import a Word document as a new article. The Word document will be converted to Markdown and placed in the specified folder.

Requirements

The DocsAsCode git repository must be downloaded and the path must be specified in the extension settings in order for this extension to function properly. Author Name must be specified in extension settings.

Extension Settings

This extension contributes the following settings:

• repoPath: DocsAsCode repository
• User Role: Identifier between Developer and BA which gives access to different functionality
• Author: The users full name
• Default View: On startup, Docs as Code tab is the default view in the side bar.