Build and Deploy the Documentation

Setup

To set everything up, clone the oqtane.docs and the oqtane.framework repositories in the same parent folder (e.g., c:\projects\oqtane), creating a structure like:

c:\projects\oqtane (example)
- oqtane.docs cloned from oqtane.docs
- oqtane.framework cloned from oqtane.framework

some-root\
├── oqtane.docs
├── oqtane.framework

That will look like this:

Folder structure for Building

Build and Test Locally

Depending on your preferred toolchain, you can use

VS Code (recommended🌟)
Visual Studio 2022

Build and Test Locally using VS Code

Run with VS Code:
- Open the Oqtane.Docs.code-workspace workspace located in the /src folder.
- Rebuild the entire solution
  - Either using Ctrl+Shift+B.
  - Or by hitting Ctrl + Shift + P and selecting "Run Task"
    
    ...and then "Build".
- In the output you should then see a bunch of stuff - ending with Build Succeeded
- It is generated into the root /docs folder.
Test Locally - three options:
- Recommended 🌟: Use the Live Server extension to serve the /docs folder on http://localhost:5500` using Alt + L, Alt + O.
- Alternatively: Use IIS Express Extension to serve the /docs folder on http://localhost:27629` using Ctrl+F5.
- Alternatively: Set up IIS to publish the /docs folder on a domain such as docs.oqtane.me.

Build and Test Locally using Visual Studio 2022

Run with Visual Studio:
- Open the Oqtane.Docs.sln solution located in the /src folder.
- Rebuild the entire solution. It is generated into the root /docs folder.
Test Locally
- Alternatively: Set up IIS to publish the /docs folder on a domain such as docs.oqtane.me.