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 an Edit button to the Documentation subsite #64

Open
jiribenes opened this issue Sep 25, 2024 · 1 comment
Open

Add an Edit button to the Documentation subsite #64

jiribenes opened this issue Sep 25, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@jiribenes
Copy link
Contributor

jiribenes commented Sep 25, 2024

Each page of the Documentation subsite could have an edit field in its header

---
layout: docs
title:  "Examples"
edit: https://github.com/effekt-lang/effekt-website/edit/master/examples.md
---

which renders as some [✏️] button somewhere in order to quickly edit the correct file in the correct repository.

If I recall correctly, GitHub should offer you to create a fork with your changes followed by a PR.
This way, it's easy enough to fix typos/problems on all documentation pages: in case studies, in the upcoming Tour de Effekt, etc.

Scala's documentation has a very similar button:
Screenshot 2024-09-25 at 19 26 58

@jiribenes jiribenes added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Sep 25, 2024
@jiribenes
Copy link
Contributor Author

Related to #80: we could not only have an "Edit" button, but also a "Link / Go to Source" button -- that would already help (and it's mostly the same code as this issue!)

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant