docs: link first component occurrence to reference pages#1527
Open
harshagarwalnyu wants to merge 1 commit into
Open
docs: link first component occurrence to reference pages#1527harshagarwalnyu wants to merge 1 commit into
harshagarwalnyu wants to merge 1 commit into
Conversation
|
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
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.
| List rendering allows you to generate multiple elements from a collection of data, such as an array or object, where each element corresponds to an item in the collection. | ||
|
|
||
| When dealing with dynamic data, Solid offers two ways to render lists: the `<For>` and `<Index>` components. | ||
| When dealing with dynamic data, Solid offers two ways to render lists: the [`<For>`](/reference/components/for) and `<Index>` components. |
|
|
||
| When an element requires rendering outside of the usual document flow, challenges related to stacking contents and z-index can interfere with the desired intention or look of an application. | ||
| `<Portal>` helps with this by putting elements in a different place in the document, bringing an element into the document flow so they can render as expected. | ||
| [`<Portal>`](/reference/components/portal) helps with this by putting elements in a different place in the document, bringing an element into the document flow so they can render as expected. |
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.
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
concepts/control-flow/portal.mdx<Portal>→ /reference/components/portalconcepts/control-flow/conditional-rendering.mdx<Show>→ /reference/components/showconcepts/control-flow/list-rendering.mdx<For>→ /reference/components/forconcepts/control-flow/dynamic.mdx<Dynamic>→ /reference/components/dynamicOnly the first plain-text occurrence in each file is linked. Code blocks and already-linked occurrences are unchanged.