Repository navigation
ENG-2407 Settings docs links point to wrong or unrelated docs pages - #1556
Merged
mdroidian merged 3 commits intoOct 27, 2026
Conversation
…ting Link to section anchors where a page covers several settings, drop links whose docs don't describe the setting, and rename "See more." to "View docs". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Entire-Checkpoint: 01M5330M4CR1A4PNK15KZZNZT2
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Entire-Checkpoint: 01M53396FYSXNFSKP0CH8ZB3Q1
No docs page describes adding relations automatically. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Entire-Checkpoint: 01M53BSZCK7MY7GHT5QBJ92TQQ
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
|
This pull request has been ignored for the connected project Preview Branches by Supabase. |
mdroidian
approved these changes
Oct 27, 2026
mdroidian
deleted the
eng-2407-settings-docs-links-point-to-wrong-or-unrelated-docs-pages
branch
October 27, 2026 02:19
trangdoan982
added a commit
that referenced
this pull request
Nov 12, 2026
…1556) * ENG-2407 Point settings docs links at the docs that describe each setting Link to section anchors where a page covers several settings, drop links whose docs don't describe the setting, and rename "See more." to "View docs". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Entire-Checkpoint: 01M5330M4CR1A4PNK15KZZNZT2 * ENG-2407 Pass unwrapped setting descriptions as plain JSX strings Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Entire-Checkpoint: 01M53396FYSXNFSKP0CH8ZB3Q1 * ENG-2407 Drop the Auto canvas relations docs link No docs page describes adding relations automatically. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Entire-Checkpoint: 01M53BSZCK7MY7GHT5QBJ92TQQ --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
3 tasks done
This branch was previously deployed
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
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.
Reviewer brief
roam-setting-overhaul). Merge that first.apps/roam/src/components/settings/utils/docs.tsxand thedocsLinkentries inapps/roam/src/components/settings/utils/settingsCatalog.ts. Components that pass their own description repeat the same link, so both places change together.withDocsLinkis shared. Both are in the screenshots below.The diagram shows how each row's link was decided.
flowchart LR A["Setting row"] --> B{"Does a docs page<br/>describe the setting?"} B -- "whole page" --> C["Link the page<br/>(trigger, shortcut, context overlay)"] B -- "one section" --> D["Link the #anchor<br/>(tag, export options,<br/>enable stored relations, node Overlay)"] B -- "no" --> E["No link<br/>(format, template, specification, query,<br/>description, text popup, tool shortcut,<br/>auto canvas relations, append referenced node)"] C & D --> F["withDocsLink: 'View docs'"]Verification
#export-options#export-options; "append referenced node" has nonecurleach URL inROAM_DOCSon discoursegraphs.compnpm ci:validateROAM_DOCS, which thecurlcheck covers.Loom video
https://www.loom.com/share/eb434414651c46c78e98d22e701ebc11
Scope check
$scope-checkagainst the ENG ticket and final diff.Done When: None. Links were also removed from rows the ticket didn't name: 4 Query settings, node Description, Text selection popup, Discourse tool keyboard shortcut, Export "append referenced node", and Auto canvas relations. They come from the full audit in the ticket's Solution and fall under "Rows with no matching docs show no link".Standards check
$dg-pr-adherence-checkagainst the final diff and PR metadata.No rule violations. The Loom is still outstanding.
Local delegated full review
$dg-delegated-full-reviewwhen no other full-review workflow is available.No correctness findings. The remaining notes were judgement calls on link targets, and they were settled during the audit.
🤖 Generated with Claude Code