Skip to content

Automate Docs#21

Merged
jbouder merged 2 commits intomainfrom
automate-docs
Nov 6, 2025
Merged

Automate Docs#21
jbouder merged 2 commits intomainfrom
automate-docs

Conversation

@jbouder
Copy link
Contributor

@jbouder jbouder commented Nov 6, 2025

Description

  • Enhanced automated docs workflow
  • Updated Readme

Related Issue

N/A

Motivation and Context

  • Ensure API Docs are up to date as code is merged

How Has This Been Tested?

N/A

Screenshots (if appropriate):

Copilot AI review requested due to automatic review settings November 6, 2025 01:20
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR automates the API documentation generation and publishing process using GitHub Actions. The workflow now automatically updates OpenAPI documentation when changes are pushed to the main branch, eliminating the need for manual documentation updates.

Key Changes:

  • Implemented GitHub Actions workflow to automatically generate and commit API documentation
  • Updated README with documentation on both automated and manual documentation processes
  • Marked documentation automation task as complete in the project roadmap

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Added comprehensive documentation explaining the automated docs workflow, updated manual process instructions to reflect correct directory structure, and marked automation task as complete
.github/workflows/update-docs.yaml Implemented complete automated documentation workflow including API server startup, OpenAPI spec download, HTML generation, and git commit/push automation

@jbouder jbouder added the ci Automation enhancements label Nov 6, 2025
@jbouder jbouder merged commit 8773b3a into main Nov 6, 2025
8 checks passed
@jbouder jbouder deleted the automate-docs branch November 6, 2025 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Automation enhancements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant