Overview
This guide provides step-by-step instructions on how to configure and run LiveDoc.
✅ Prerequisites
Before getting started, ensure the following are in place:
- 🔒 You must have an internal role in the Developer Portal.
- 🔑 A Personal Access Token (PAT) for the repository must be stored in the Developer Portal Key Vault. More info
- 📁 Canvas files should be located in a
canvasfolder in the specified branch of your repository. More info
🧭 Steps to configure My LiveDoc
1. Log into the Developer Portal
Sign in to the Developer Portal with your internal credentials.
2. Access your profile summary
- Click your profile avatar in the top-right corner.
- Select Profile summary from the dropdown.
3. Open My LiveDoc configuration
- Scroll to the My LiveDoc configuration section.
- Click View my LiveDoc configuration.
⚠️ This section is only visible if you have the internal role.
4. Create a new configuration
- On the new page, click the Create button.
- Fill in the configuration details as described below:
🛠 Configuration details
🔷 My LiveDoc configuration
| Field | Description |
|---|---|
| Title | Title of the product |
| Author’s username | Username of the author |
📦 Repository
| Field | Description |
|---|---|
| URL | Repository URL (supports GitHub and Azure DevOps) |
| Branch | The branch where LiveDoc will run |
| Token identifier | Key to the PAT stored in Developer Portal key vault |
⏱ Scheduling
| Option | Description |
|---|---|
| None | No automatic generation |
| Daily | Run LiveDoc daily |
| Monthly | Run LiveDoc monthly |
🎨 Product canvas
Upload your canvas files in the canvas folder of the selected repository branch.
🧹 Code scanning settings
| Field | Description |
|---|---|
| Folder depth | How deep to scan folders |
| Ignore list | Folders or files to exclude from scanning |
| Source file extension safelist | List of allowed source file extensions |
| Target project filenames | List of project file names to include (e.g. .csproj) |
| Deprecated packages | List of packages to flag as deprecated |
5. Save the configuration
Click the Save button to store the new configuration in the Cosmos database.
6. Run LiveDoc
- Click the Run now button to generate your report.
- A confirmation message will appear.
- 📋 Note the instance ID provided. It’s useful for troubleshooting if an error occurs.
✅ Result
The generated LiveDoc report will be automatically published to the Developer Portal site.
If you haven’t created your PAT yet, follow this step-by-step guide.