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

References to github files #77

Closed
jambulud opened this issue Oct 31, 2019 · 2 comments
Closed

References to github files #77

jambulud opened this issue Oct 31, 2019 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jambulud
Copy link
Member

As a user, I want to have links in documentation files referencing themselves (its github url) so that when I see these file in the website I can click its link, go to github and modify the file.

Nowadays when you find an error through the website, you don't know which file to modify so it is difficult to contribute.

@jambulud jambulud added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 31, 2019
@jambulud jambulud pinned this issue Oct 31, 2019
@maybeec
Copy link
Member

maybeec commented Jan 27, 2020

We should have a pencil next to chapters/sections, which you could click on and finally jump to github to the right section, so you could directly adapt it.
I even thought of embedding github in an iframe (if possible) and provide a custom banner on the top, which even provides a 3-step guide how to really do the adaptions on github as most of the people don't know how easy it is and that they cannot break anything.

@SchettlerKoehler
Copy link
Member

This was already done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants