Skip to content

Conversation

jonthysell
Copy link
Contributor

@jonthysell jonthysell commented May 31, 2025

Description

This PR updates the API docs under /docs/native-api/ using a new script: .github/scripts/UpdateNativeApiDocs.ps1 which merges the Old and New Architecture docs generated from a given CI build Id.

Example usage: .\.github\scripts\UpdateNativeApiDocs.ps1 621436

This PR also cleans up various links that don't work in the docs generated by winmd2md:

Why

Our docs did not including the new types we created in the New Architecture binaries, nor specify the differences between APIs for New and Old Architecture.

Screenshots

N/A

Microsoft Reviewers: Open in CodeFlow

@jonthysell jonthysell force-pushed the hybridnativeapidocs branch 7 times, most recently from 0a9d0ef to ffc3aeb Compare June 3, 2025 16:32
@jonthysell jonthysell changed the title [WIP] Updated Native API docs with new UpdateNativeApiDocs.ps1 script Updated Native API docs with new UpdateNativeApiDocs.ps1 script Jun 3, 2025
@jonthysell jonthysell force-pushed the hybridnativeapidocs branch from ffc3aeb to c50ea6e Compare June 3, 2025 17:50
@jonthysell jonthysell marked this pull request as ready for review June 3, 2025 17:59
@jonthysell jonthysell requested review from a team as code owners June 3, 2025 17:59
@jonthysell jonthysell enabled auto-merge (squash) June 3, 2025 18:37
Copy link
Contributor

@TatianaKapos TatianaKapos left a comment

Choose a reason for hiding this comment

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

LGTM, love the script!

@jonthysell jonthysell disabled auto-merge June 6, 2025 17:48
@jonthysell jonthysell merged commit 0840528 into microsoft:main Jun 6, 2025
29 of 31 checks passed
@jonthysell jonthysell deleted the hybridnativeapidocs branch June 6, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants