Introduction

This article provides instructions on setting up the local development environment for the Copper.Docs solution. The instructions mentioned in this article assume that you have access to the resources mentioned below. If this is not the case, please ask the architect/team lead.

• Copper.Docs Git repository (https://qnh@dev.azure.com/qnh/Copper/_git/Copper.Docs)

Install Visual Studio Code

Install Visual Studio Code from https://code.visualstudio.com/download.

Install the following Visual Studio Code plugins

• Code Spell Checker
• Markdown All in One
• Markdown Paste - Used for pasting images into Markdown documents.

Install Chocolatey

Using the following PowerShell command.

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

Install DocFx

Install DocFx using the following command-line command. (Administrator command prompt)

choco install docfx --version 2.56.1 -y

Clone the repo

Clone the following repo with this link

vscode://vscode.git/clone?url=https://qnh@dev.azure.com/qnh/Copper/_git/Copper.Docs

Use the following local path: C:\projects\Copper.Docs.

Run DocFx locally

Navigate to the tool directory

Execute the following command:

run-docfx.bat

Navigate to http://localhost:8080 to see the local documentation site.

Writing documentation

Some tips for writing.

• Ensure your spell checker is enabled
• Use CTRL + ALT + V command to paste images and place them in the /images folder.