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

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

Closed
mattapperson opened this issue Mar 10, 2018 · 8 comments
Closed
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries EUI Plus New EUI site stale-issue task A task associated with a larger Meta issue

Comments

@mattapperson
Copy link
Contributor

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

@cjcenizal cjcenizal self-assigned this Mar 10, 2018
@cjcenizal
Copy link
Contributor

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.

@mattapperson
Copy link
Contributor Author

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

@timroes
Copy link
Contributor

timroes commented Mar 10, 2018

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.

@mattapperson
Copy link
Contributor Author

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

@cjcenizal
Copy link
Contributor

I really like that idea @mattapperson!

@snide snide added the documentation Issues or PRs that only affect documentation - will not need changelog entries label Mar 13, 2018
@cjcenizal cjcenizal removed their assignment Jun 18, 2018
@snide snide mentioned this issue Mar 9, 2021
41 tasks
@cchaos
Copy link
Contributor

cchaos commented Mar 10, 2021

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

@github-actions
Copy link

github-actions bot commented Sep 6, 2021

👋 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
Copy link

👋 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.

@tkajtoch tkajtoch added New EUI site task A task associated with a larger Meta issue labels Mar 27, 2024
@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
@JasonStoltz JasonStoltz added task A task associated with a larger Meta issue and removed task A task associated with a larger Meta issue labels Jan 8, 2025
@JasonStoltz JasonStoltz closed this as not planned Won't fix, can't repro, duplicate, stale Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries EUI Plus New EUI site stale-issue task A task associated with a larger Meta issue
Projects
None yet
Development

No branches or pull requests

8 participants