Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Links in props tables can exist without their target #5185

Open
chandlerprall opened this issue Sep 15, 2021 · 2 comments
Open

[Docs] Links in props tables can exist without their target #5185

chandlerprall opened this issue Sep 15, 2021 · 2 comments
Labels
bug documentation Issues or PRs that only affect documentation - will not need changelog entries

Comments

@chandlerprall
Copy link
Contributor

For example, go to the data grid in-memory settings doc and open the Props tab. leadingControlColumns links to the EuiDataGridControlColumn definition, but it doesn't exist on the page so clicking the link goes nowhere.

@chandlerprall chandlerprall added bug documentation Issues or PRs that only affect documentation - will not need changelog entries discussion labels Sep 15, 2021
@elizabetdev
Copy link
Contributor

Notice on this PR #5214 that @constancecchen linked the page this way:

* Optional props to pass to the underlying [EuiPopover](/#/layout/popover).

Should we be linking in all Props tabs like [EuiPopover](/#/layout/popover) instead of #EuiPopover?

@cchaos
Copy link
Contributor

cchaos commented Sep 28, 2021

We've usually used the #Component method when it's actually a nested type, like #EuiDataGridControlColumn. Not to an entirely separate component like the popover example. So I think technically both are still valid. Even swapping the # shortcut for a manual []() MD link, won't validate whether the anchor exists.

@github-actions github-actions bot added the Stale label Oct 4, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 11, 2024
@cee-chen cee-chen reopened this Oct 14, 2024
@cee-chen cee-chen removed the Stale label Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Issues or PRs that only affect documentation - will not need changelog entries
Projects
None yet
Development

No branches or pull requests

4 participants