eui icon indicating copy to clipboard operation
eui copied to clipboard

Add link for each component in the docs to it's source on GitHub

Open mattapperson opened this issue 7 years ago • 8 comments

A lot of my time using EUI I am making a quick jump to the source to understand some detail of the component. Having a link in the docs would save me a lot of time debugging small quirks

mattapperson avatar Mar 10 '18 02:03 mattapperson

I tried to find a way to do this using Webpack but came up empty-handed. Possibly we can just hit the GitHub search API and link to files that way.

cjcenizal avatar Mar 10 '18 02:03 cjcenizal

As an alternative... what if docs were co-located with the components? would make stuff like this easier...

mattapperson avatar Mar 10 '18 02:03 mattapperson

I would also like the approach a lot, of having the docs directly co-located with the components. I think that would support the concept of encapsulated components even better if we don't split up between docs and sources.

timroes avatar Mar 10 '18 14:03 timroes

We could just use a file naming convention of *.doc.js for docs... or a sub-folder, but I would vote for file sub-extension

mattapperson avatar Mar 10 '18 15:03 mattapperson

I really like that idea @mattapperson!

cjcenizal avatar Mar 12 '18 23:03 cjcenizal

We'll be tackling some documentation features this year and I'll add this as something to look into.

cchaos avatar Mar 10 '21 14:03 cchaos

👋 Hey there. This issue hasn't had any activity for 180 days. We'll automatically close it if that trend continues for another week. If you feel this issue is still valid and needs attention please let us know with a comment.

github-actions[bot] avatar Sep 06 '21 16:09 github-actions[bot]

👋 Hi there - this issue hasn't had any activity in 6 months. If the EUI team has not explicitly expressed that this is something on our roadmap, it's unlikely that we'll pick this issue up. We would sincerely appreciate a PR/community contribution if this is something that matters to you! If not, and there is no further activity on this issue for another 6 months (i.e. it's stale for over a year), the issue will be auto-closed.

github-actions[bot] avatar Oct 22 '23 00:10 github-actions[bot]