search

elastic / eui

Elastic UI Framework 🙌
https://eui.elastic.co/
Other
6.09k stars 838 forks source link

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

Open chandlerprall opened 3 years ago

chandlerprall commented 3 years ago

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.

miukimiu commented 3 years ago

Notice on this PR #5214 that @constancecchen linked the page this way: https://github.com/elastic/eui/blob/91abf407a6ba3dee9cab38e167c3d51aa5af8812/src/components/form/super_select/super_select.tsx#L77

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

cchaos commented 3 years ago

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.