-
Notifications
You must be signed in to change notification settings - Fork 839
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
Add link for each component in the docs to it's source on GitHub #491
Comments
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. |
As an alternative... what if docs were co-located with the components? would make stuff like this easier... |
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. |
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 |
I really like that idea @mattapperson! |
We'll be tackling some documentation features this year and I'll add this as something to look into. |
👋 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. |
👋 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. |
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
The text was updated successfully, but these errors were encountered: