docs: improve related docs links in pinning models page#1029
Conversation
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
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: https://layer5io.github.io/docs/pr-preview/pr-1029/
|
nafisa404
force-pushed
the
issue-1028-related-docs-pinning-models
branch
from
ff3fbe6 to
980487f
Compare
| Pinning models to the dock allows you to quickly access your most used models. This is a great way to keep your workspace organized and efficient. | ||
| videoId: "8lQ6ed_1Tss" | ||
| videoType: youtube | ||
| Pinning models to the dock allows you to quickly access your most used models. |
| @@ -1,27 +1,37 @@ | |||
| --- | |||
| title: "Pinning Models to Dock" | |||
| title: 'Pinning Models to Dock' | |||
| videoType: youtube | ||
| Pinning models to the dock allows you to quickly access your most used models. | ||
| This is a great way to keep your workspace organized and efficient. | ||
| videoId: '8lQ6ed_1Tss' |
|
|
||
| Related Docs: | ||
| 1. https://docs.layer5.io/kanvas/designer/understanding-tool-modes/ | ||
| ### Related Docs |
There was a problem hiding this comment.
We need to be using a partial / shortcode here.
@CodexRaunak guidance?
There was a problem hiding this comment.
@Bhumikagarggg @banana-three-join, learn this area.
Ensure that we don't need hardcoded "related docs" sections, but that each page has this dynamically built-int.
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
4 participants
Description
Related Issue
Closes #1028
Notes
This change improves documentation UX by replacing raw URLs with descriptive links and adding an additional relevant resource.
Verification
npx prettier --check content/en/videos/getting-started/basics/pinning-models-to-dock.mdnpm run _check:links