Add Tech Spec for rendering README in PM UI #13200
Conversation
|
Looks good left a few comments to help |
Co-authored-by: Nigusu Solomon Yenework <[email protected]>
…Get/Home into dev-jgonz-pmuiReadmeRendering
|
Review Meeting: |
jgonz120
requested review from
joelverhagen,
jebriede,
nkolev92,
donnie-msft,
kartheekp-ms and
Nigusu-Allehu
|
Can we update the title of this PR to something more representative? |
jgonz120
changed the title
| ... | ||
| } | ||
| ``` | ||
| ##### PackageBaseAddress/6.12.0 | ||
|
|
||
| A new version of the [package content](https://learn.microsoft.com/en-us/nuget/api/package-base-address-resource) resource type which will include a url definition for downloading the README. |
There was a problem hiding this comment.
Pedantic: This example below is not showing the URL to download the readme, it's showing a base URL, for which a URL has to be generated. It also doesn't tell us what the generated URL will be. See the docs for examples how they explain to both service and client implementors what the expected URL will be.
Guessing from the registration example's rawReadMeUrl, I assume the proposed filename will be readme. Consider the two documented resources both have file extensions, and embedded readmes only support markdown, should it be readme.md?
There was a problem hiding this comment.
I can update the doc, as for the URI. Users can pick whatever name they want for the README. If we set the api {@id}/{LOWER_ID}/{LOWER_VERSION}/readme.md it implies like are specifically looking for that file. As opposed to /readme which leaves it open to whatever readme is available for that package.
There was a problem hiding this comment.
yes, the doc needs to explain how server implementors tell client what filename to use (what pattern client will use to generate the URl that will be requested)
Tech spec for #12583