Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 26, 2025

The README lacked context about the repository's purpose and how the CI/CD pipeline operates.

Added comprehensive documentation:

  • Repository overview: Clarified this is an internal PowerOffice repository hosting interactive API documentation using React + Swagger UI, deployed to Azure Static Web Apps

  • GitHub Actions workflow breakdown:

    • Triggers: Push to main/dev/staging branches and PRs to main
    • Build pipeline: Schema name simplification → npm install/ci → Vite build → Azure deployment
    • Explained the SimplifySchemaNames.cjs preprocessing step that transforms verbose .NET type names in OpenAPI specs
    • PR preview deployments and cleanup on close
  • Local development: Setup instructions, build commands, and preview workflow

  • Contributing workflow: Branch strategy and deployment targets for internal team members

Key technical detail: The workflow runs a preprocessing step (node ./openapi/SimplifySchemaNames.cjs) before build to strip unnecessary .NET assembly metadata from OpenAPI schema references, improving documentation readability.

Original prompt

Expand on the #Readmin file. Add description about the repository and how the github action works. This is a internal repository for our organization


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits November 26, 2025 11:46
…ntation

Co-authored-by: kridah <10164781+kridah@users.noreply.github.com>
…ing workflow

Co-authored-by: kridah <10164781+kridah@users.noreply.github.com>
Copilot AI changed the title [WIP] Expand README file with repository and GitHub Actions details Expand README with repository description and GitHub Actions workflow documentation Nov 26, 2025
Copilot AI requested a review from kridah November 26, 2025 11:50
Copilot finished work on behalf of kridah November 26, 2025 11:50
@kridah kridah marked this pull request as ready for review November 26, 2025 12:36
@kridah
Copy link
Collaborator

kridah commented Nov 26, 2025

lgtm

@kridah kridah closed this Nov 26, 2025
@kridah kridah reopened this Nov 26, 2025
@kridah kridah merged commit ae8c2cf into main Nov 26, 2025
4 checks passed
@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://gray-stone-017611203-6.westeurope.3.azurestaticapps.net

@kridah kridah deleted the copilot/expand-readme-description branch November 26, 2025 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants