docs: replace hardcoded Related Docs with Related Reading#1129
Open
nafisa404 wants to merge 4 commits into
Open
docs: replace hardcoded Related Docs with Related Reading#1129nafisa404 wants to merge 4 commits into
nafisa404 wants to merge 4 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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.
Contributor
|
🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1129/
|
Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
nafisa404
force-pushed
the
issue-1028-related-reading
branch
from
278c6e9 to
d660d24
Compare
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. |
Contributor
|
@nafisa404 Keep me updated if you need any help |
… before related-reading migration
…candidates related-reading.html used .Site.RegularPages.Related, but Hugo's RegularPages structurally excludes every _index.md (section) page. This meant a section landing page (e.g. kanvas/operator/_index.md) could never appear in another page's Related Reading, no matter how its tags/categories lined up. Widen the candidate pool to Pages filtered to Kind in [page, section] before calling .Related. Verified with a before/after build diff across the whole site (dumped Related Reading links for all 1519/1523 pages, before vs after): zero pages lost their Related Reading section, 2 previously-invisible relationships now correctly surface, and the ~66 pages whose list composition shifted did so only because section pages joined the eligible pool, not because of any lost or broken links. Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
nafisa404
added a commit
to nafisa404/docs
that referenced
this pull request
Jul 2, 2026
Repo-wide follow-up to PR layer5io#1129 (issue layer5io#1028), applying the same pattern used for Pinning Models to the Dock / Understanding Tool Modes across the rest of the docs: remove hardcoded "Related Docs"/"See Also"/"Related pages"/"Related" link blocks and inline references, and let the site's taxonomy-driven Related Reading partial surface the same connections via categories/tags instead. Migrated: - videos/getting-started/basics/operator-overview.md (-> kanvas/operator/_index.md) - videos/getting-started/basics/designer-overview.md (-> kanvas/designer/_index.md) - videos/getting-started/comments/design-reviews-full.md (-> kanvas/designer/comments/index.md) - kanvas/operator/log-streaming/index.md <-> interactive-terminal/index.md, advanced/performance/index.md - kanvas/operator/interactive-terminal/index.md <-> log-streaming/index.md - kanvas/advanced/render-modes.md <-> autopan.md, performance/index.md, url-parameters/index.md - kanvas/advanced/autopan.md <-> render-modes.md, performance/index.md, url-parameters/index.md - kanvas/advanced/performance/index.md <-> render-modes.md, autopan.md - cloud/guides/organizations/configuration-scenarios/index.md <-> white-labeling, identity-services, organizations (concept), identity-and-security Front matter changes, only where existing categories/tags didn't already establish the connection: - log-streaming + interactive-terminal: added tags: [troubleshooting] (shared category Operator alone is a 7-way tie that doesn't reliably survive the top-6 cutoff) - operator-overview.md + kanvas/operator/_index.md: added tags: [operator-overview] - designer-overview.md + kanvas/designer/_index.md: added tags: [designer-overview] (uncommented/set; was previously commented out) - configuration-scenarios.md, white-labeling/_index.md, identity-services/index.md, identity-and-security/_index.md: added the existing "orgs" tag where missing, so each shares 2-3 tags with configuration-scenarios rather than relying on the generic Identity category alone (13 pages deep, easily crowded out of the top 6) Depends on the related-reading.html section-page fix in the preceding commit for 5 of these links (kanvas/operator/_index.md, kanvas/designer/_index.md, white-labeling/_index.md, organizations/_index.md, identity-and-security/_index.md are all section pages). Verified: hugo build (1523 pages, no errors) and manual inspection of rendered Related Reading output on every migrated page. Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
Repo-wide follow-up to PR layer5io#1129 (issue layer5io#1028), applying the same pattern used for Pinning Models to the Dock / Understanding Tool Modes across the rest of the docs: remove hardcoded "Related Docs"/"See Also"/"Related pages"/"Related" link blocks and inline references, and let the site's taxonomy-driven Related Reading partial surface the same connections via categories/tags instead. Migrated: - videos/getting-started/basics/operator-overview.md (-> kanvas/operator/_index.md) - videos/getting-started/basics/designer-overview.md (-> kanvas/designer/_index.md) - videos/getting-started/comments/design-reviews-full.md (-> kanvas/designer/comments/index.md) - kanvas/operator/log-streaming/index.md <-> interactive-terminal/index.md, advanced/performance/index.md - kanvas/operator/interactive-terminal/index.md <-> log-streaming/index.md - kanvas/advanced/render-modes.md <-> autopan.md, performance/index.md, url-parameters/index.md - kanvas/advanced/autopan.md <-> render-modes.md, performance/index.md, url-parameters/index.md - kanvas/advanced/performance/index.md <-> render-modes.md, autopan.md - cloud/guides/organizations/configuration-scenarios/index.md <-> white-labeling, identity-services, organizations (concept), identity-and-security Front matter changes, only where existing categories/tags didn't already establish the connection: - log-streaming + interactive-terminal: added tags: [troubleshooting] (shared category Operator alone is a 7-way tie that doesn't reliably survive the top-6 cutoff) - operator-overview.md + kanvas/operator/_index.md: added tags: [operator-overview] - designer-overview.md + kanvas/designer/_index.md: added tags: [designer-overview] (uncommented/set; was previously commented out) - configuration-scenarios.md, white-labeling/_index.md, identity-services/index.md, identity-and-security/_index.md: added the existing "orgs" tag where missing, so each shares 2-3 tags with configuration-scenarios rather than relying on the generic Identity category alone (13 pages deep, easily crowded out of the top 6) Depends on the related-reading.html section-page fix in the preceding commit for 5 of these links (kanvas/operator/_index.md, kanvas/designer/_index.md, white-labeling/_index.md, organizations/_index.md, identity-and-security/_index.md are all section pages). Verified: hugo build (1523 pages, no errors) and manual inspection of rendered Related Reading output on every migrated page. Signed-off-by: Nafisa Tahasin <nafisatahasin23@gmail.com>
nafisa404
force-pushed
the
issue-1028-related-reading
branch
from
4eead33 to
781fce3
Compare
Contributor
Author
|
@banana-three-join Implemented the requested changes by removing the remaining hardcoded Related Docs, See Also, and similar sections across the docs and migrating those relationships to the frontmatter using tags/categories for the automatic Related Reading system. |
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Related Docshyperlink from the Pinning Models to the Dock page.Docktag 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.htmlapproach while minimizing changes.Resolves: #1028
Locally tested