Skip to content

docs: link first component occurrence to reference pages#1527

Merged
LadyBluenotes merged 2 commits into
solidjs:mainfrom
harshagarwalnyu:docs/link-components-to-reference
May 31, 2026
Merged

docs: link first component occurrence to reference pages#1527
LadyBluenotes merged 2 commits into
solidjs:mainfrom
harshagarwalnyu:docs/link-components-to-reference

Conversation

@harshagarwalnyu
Copy link
Copy Markdown
Contributor

Closes #745

Each concept page's first inline mention of a Solid component now links to its API reference page, making navigation from concept docs to full API docs easy.

Pages updated

Page Component linked
concepts/control-flow/portal.mdx <Portal>/reference/components/portal
concepts/control-flow/conditional-rendering.mdx <Show>/reference/components/show
concepts/control-flow/list-rendering.mdx <For>/reference/components/for
concepts/control-flow/dynamic.mdx <Dynamic>/reference/components/dynamic

Only the first plain-text occurrence in each file is linked. Code blocks and already-linked occurrences are unchanged.

Copilot AI review requested due to automatic review settings May 31, 2026 09:34
@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 31, 2026

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit d59ca63
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/6a1c90160cc9460008da14fa
😎 Deploy Preview https://deploy-preview-1527--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds direct links from the “Control Flow” concept pages to the corresponding component reference docs to improve navigability.

Changes:

  • Linked <Portal>, <Dynamic>, and <Show> mentions to their reference pages
  • Linked <For> mention to its reference page in list rendering docs

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
src/routes/(0)concepts/(1)control-flow/(4)portal.mdx Links <Portal> mention to the Portal reference page
src/routes/(0)concepts/(1)control-flow/(2)dynamic.mdx Links <Dynamic> mention to the Dynamic reference page
src/routes/(0)concepts/(1)control-flow/(1)list-rendering.mdx Links <For> mention to the For reference page
src/routes/(0)concepts/(1)control-flow/(0)conditional-rendering.mdx Links <Show> mention to the Show reference page

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/routes/(0)concepts/(1)control-flow/(1)list-rendering.mdx
Comment thread src/routes/(0)concepts/(1)control-flow/(4)portal.mdx
@LadyBluenotes LadyBluenotes enabled auto-merge (squash) May 31, 2026 19:45
@LadyBluenotes LadyBluenotes merged commit 0ac6613 into solidjs:main May 31, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Content]: Link to reference on first occurrence of each term

3 participants