Expand README with repository description and GitHub Actions workflow documentation #6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
main/dev/stagingbranches and PRs tomainSimplifySchemaNames.cjspreprocessing step that transforms verbose .NET type names in OpenAPI specsLocal 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
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.