phel-lang / phel-lang.org

Phel website
https://phel-lang.org
MIT License
11 stars 10 forks source link

Add "Edit me" links #45

Closed Chemaclass closed 6 months ago

Chemaclass commented 1 year ago

Description

Adding an "Found a typo, edit me!" link at the top of the page can help users to submit their own PR with the typo fixed within a few clicks. I got this in my own website, and it was used a few times. E.g:

Note: The presentation here is just an example. We can have a different style for the phel website.

Screenshot 2022-12-17 at 18 51 10

Source code: https://github.com/Chemaclass/chemaclass.com/blob/master/templates/blog/blog-post.html#L52

Extra

The API page is special, because it's generated/build on the fly using the real funtion-docs from the core language. So in that page we can help users to submit an issue when they find a typo.