Skip to content

Update API spec template#1580

Merged
david-risney merged 4 commits intomasterfrom
api-spec-template-update
Aug 4, 2021
Merged

Update API spec template#1580
david-risney merged 4 commits intomasterfrom
api-spec-template-update

Conversation

@david-risney
Copy link
Copy Markdown
Contributor

The Project Reunion folks merged and updated their templates. This is an effort to more closely align ours with their spec template. But still not entirely matching for good reason:

  • I've updated example links to point to good webview2 specs.
  • I've removed the API Pages section because our API documentation process is different than theirs. For ours, documentation comes from /// comments on the COM IDL. I don't want folks to have multiple copies of that in the doc and instead have reviewers give feedback on and focus on getting correct the one copy.
  • We have COM IDL in addition to WinRT MIDL3.
  • I added a note about where to find the generated MIDL3.

The Project Reunion folks merged and updated their templates. This is an effort to more closely align ours with [their spec template](https://github.com/microsoft/WindowsAppSDK/blob/main/specs/spec_template.md). But still not entirely matching for good reason:
 * I've updated example links to point to good webview2 specs.
 * I've removed the API Pages section because our API documentation process is different than theirs. For ours, documentation comes from /// comments on the COM IDL. I don't want folks to have multiple copies of that in the doc and instead have reviewers give feedback on and focus on getting correct the one copy.
 * We have COM IDL in addition to WinRT MIDL3.
 * I added a note about where to find the generated MIDL3.
Comment thread specs/template.md Outdated
@jasonstephen15 jasonstephen15 requested a review from Reezaali July 28, 2021 20:03
Copy link
Copy Markdown
Contributor

@jasonstephen15 jasonstephen15 left a comment

Choose a reason for hiding this comment

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

Looks good! This should be really helpful in the future in exporting this info to public docs.

Comment thread specs/template.md Outdated
david-risney and others added 2 commits August 4, 2021 10:14
Co-authored-by: Jason Stephen <22718545+jasonstephen15@users.noreply.github.com>
@david-risney david-risney merged commit 81b2e48 into master Aug 4, 2021
@david-risney david-risney deleted the api-spec-template-update branch August 4, 2021 17:16
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.

3 participants