json-api-dotnet
Fix broken doc links
This PR fixes broken links in the docs/usage/extensibility/resource-definitions.md file
Closes #{ISSUE_NUMBER}
QUALITY CHECKLIST
- [ ] Changes implemented in code
- [X] Complies with our contributing guidelines
- [ ] Adapted tests
- [X] Documentation updated
Codecov Report
Merging #1171 (bc18441) into master (0185311) will not change coverage. The diff coverage is
n/a.
@@ Coverage Diff @@
## master #1171 +/- ##
=======================================
Coverage 92.58% 92.58%
=======================================
Files 241 241
Lines 7700 7700
=======================================
Hits 7129 7129
Misses 571 571
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi @leandroaraujosouza, thanks for taking the time to create a PR. Though I'm confused: where do you see these links are broken? They seem to render properly at https://www.jsonapi.net/usage/extensibility/resource-definitions.html. The ~ paths are resolved by docfx, which we use to build the documentation website. We use these links so that docfx validates them and reports build warnings when they break.
Hi @leandroaraujosouza, thanks for taking the time to create a PR. Though I'm confused: where do you see these links are broken? They seem to render properly at https://www.jsonapi.net/usage/extensibility/resource-definitions.html. The
~paths are resolved by docfx, which we use to build the documentation website. We use these links so that docfx validates them and reports build warnings when they break.
Hi @bkoelman I see them broken when browsing through the repo -> https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/docs/usage/extensibility/resource-definitions.md
I'll be reading more about docfx to understand better so I can propose a solution that works in both cases.