Documentation links in packages' READMEs, samples should reference tagged locations
See original GitHub issueRelated to https://github.com/Azure/azure-sdk-for-net/issues/29304#issuecomment-1156802781, our links to samples in our language repo from both the nuget.org-rendered README as well as the samples browser all reference the main
branch. For beta features, this can present a lot of confusion since the samples may not match the currently-published package (release or beta).
Could we do a local edit during the build pipeline to used tagged links before dotnet pack
and during docs ingestion, for example?
/cc @scbedd @weshaggard
Issue Analytics
- State:
- Created a year ago
- Comments:6 (6 by maintainers)
Top Results From Across the Web
The correct way to document a tagged version using ...
I document my software using the README.org file, which is rendered nicely in the master branch in GitHub. Now, suppose I create a...
Read more >Add a README to Your NuGet Package
We're excited to announce that you can finally pack a README.md file in your NuGet package and have it fully rendered on NuGet.org!...
Read more >About READMEs - GitHub Docs
If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the ....
Read more >About package README files
The README file will be shown on the package page. An npm package README file must be in the root-level directory of the...
Read more >README File – Everything you Need to Know
A README file is a text file that describes and launches a project. It comprises information that is frequently needed to grasp the...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@heaths I’ll ping an email to you offline.
Do we have a contact we can ping?