-
Notifications
You must be signed in to change notification settings - Fork 325
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: use QGB permalinks to appease markdown link check #2750
Conversation
Codecov Report
@@ Coverage Diff @@
## v1.x #2750 +/- ##
=======================================
Coverage 20.20% 20.20%
=======================================
Files 139 139
Lines 16237 16237
=======================================
Hits 3280 3280
Misses 12649 12649
Partials 308 308 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for handling this. I think it would be better to use x/blobstream in the link and keep main branch instead of referring to old docs before the rename.
I think links to docs should use permalinks so that we don't break the links again due to a future rename or docs move. Also I think it's a bit confusing that the v1.x branch contains references to "qgb" and then links to "blobstream" docs. If we do that, the docs should clarify the name change. |
True, we're planning to write a small ADR around renaming so that it's more clear |
IDK what to do for this PR but I don't think we should remain content with CI ❌ s on all future PRs to the v1.x branch. Three options I can see to get this moving forward (in order of preference from most preferred to least):
Ultimately I defer to you @sweexordious b/c you're the primary owner on QGB docs |
Closes #2749
Note: we've discussed avoiding backporting docs changes so we can close this PR if we're okay with markdown link check failing on the v1.x branch from now on.
Testing
On the v1.x branch, locally
make markdown-link-check
passes