docs: improve related docs links in pinning models page#1029
docs: improve related docs links in pinning models page#1029nafisa404 wants to merge 10 commits into
Conversation
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
There was a problem hiding this comment.
Code Review
This pull request updates the 'Pinning Models to Dock' documentation by refining the frontmatter formatting, improving text wrapping for better readability, and restructuring the 'Related Docs' section using Markdown list syntax. Feedback from the review suggests improving the document's structural hierarchy by using a level 2 heading for the 'Related Docs' section and ensuring that link text consistently matches the titles of the destination pages.
|
Preview deployment for PR #1029 removed. This PR preview was automatically pruned because we keep only the 6 most recently updated previews on GitHub Pages to stay within deployment size limits. If needed, push a new commit to this PR to generate a fresh preview. |
ff3fbe6 to
980487f
Compare
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
|
@nafisa404 Thank you for your contribution! Let's discuss this during the website call tomorrow at 5:30 PM IST | 7 AM CST Add it as an agenda item to the meeting minutes, if you would 🙂 |
There was a problem hiding this comment.
Hi @nafisa404,
Have all the requested changes/review comments been addressed now? If yes, could you please resolve/close the pending review conversations so that the PR can proceed ahead.
Thank you!
|
Hi @KatalKavya96 yes, all the requested review comments have been addressed. The Related Docs section is now rendered through a reusable Hugo partial instead of a hardcoded section, and the review conversations have been resolved. |
|
@nafisa404 Thanks for confirming. Could you please push a small commit or re-trigger the preview deployment once, so I can verify the rendered page visually before moving ahead with the review? |
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
125946c to
e64b945
Compare
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
|
@CodexRaunak @leecalcote I think this is ready to be merged.. |
|
@banana-three-join, please consider this in context of the active work ensuing in the area of Related Reading. |
|
@nafisa404 Recently, a related-reading.html layout was added so all of the hardcoded and dynamic suggestions through the docs which don't use this new layout need to be removed. I'll go ahead and request an update to the PR and if you want, I can have you assigned still for the fix. I'll be helping you out as well if you have any questions so please let me know. Otherwise, I'll go ahead and close the PR so I can work on it. |
|
@banana-three-join yes, I’d like to keep working on the fix if that’s okay. I’ll update the PR to align with the newer Appreciate the help! |
|
@nafisa404 Okay, ty. You can also message me over in the slack channel if you have any questions. |
Description
Related Issue
Closes #1028
Notes
This change improves documentation UX by replacing raw URLs with descriptive links and adding an additional relevant resource.