Skip to content

docs: replace hardcoded Related Docs with Related Reading#1129

Open
nafisa404 wants to merge 1 commit into
layer5io:masterfrom
nafisa404:issue-1028-related-reading
Open

docs: replace hardcoded Related Docs with Related Reading#1129
nafisa404 wants to merge 1 commit into
layer5io:masterfrom
nafisa404:issue-1028-related-reading

Conversation

@nafisa404

@nafisa404 nafisa404 commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Description

This PR updates the "Pinning Models to the Dock" documentation to use the existing Related Reading mechanism instead of a hardcoded Related Docs link.

Changes

  • Removed the obsolete hardcoded Related Docs hyperlink from the Pinning Models to the Dock page.
  • Added the Dock tag to the Understanding Tool Modes page so it is automatically surfaced by the existing Related Reading implementation.

This keeps related content consistent with the current related-reading.html approach while minimizing changes.

Resolves: #1028
Locally tested
image

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds the "Dock" tag to the "Understanding Tool Modes" documentation page and removes a related documentation link from the "Pinning Models to Dock" page. The reviewer suggested using lowercase for the "dock" tag to maintain casing consistency and questioned the semantic relevance of adding this tag to the tool modes page.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

weight: 3
categories: [Designer]
tags: [designs]
tags: [designs, Dock]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The tag 'Dock' is capitalized, while 'designs' is lowercase. To maintain consistency and prevent duplication in case-sensitive tag indexes, it is best to use lowercase for all tags (e.g., 'dock'). Additionally, consider whether 'dock' is semantically appropriate for this page. 'Understanding Tool Modes' focuses on the canvas interaction tools (Select, Pencil, Pen, Pan) and does not mention the dock. Tagging it with 'dock' solely to force a related reading link might pollute the tag's search results with unrelated content.

Suggested change
tags: [designs, Dock]
tags: [designs, dock]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Please take care to address all open feedback that has been offered. Ultimately, there should be no unresolved or unaddressed comment - whether you have elected to reject the feedback and want to offer justification as to why, or whether you have accepted the feedback and need to describe how.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1129/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
@nafisa404 nafisa404 force-pushed the issue-1028-related-reading branch from 278c6e9 to d660d24 Compare June 29, 2026 16:26
@banana-three-join

Copy link
Copy Markdown
Contributor

The scope of the replacement is a bigger one. Take a look at the following example: meshery/meshery#20150

You have to make sure that all of the hardcoded "See also", "Related reading", "Related Suggestions", etc are removed from the repo. So, just how you went and removed this one and added a topic to the categories/tags within the frontmatter, you have to do so in all of the removed hardcoded instances to make sure that the related reading suggestions are not lost.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants