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

Make changes easier to detect #538

Open
ploeh opened this issue Dec 21, 2019 · 1 comment
Open

Make changes easier to detect #538

ploeh opened this issue Dec 21, 2019 · 1 comment

Comments

@ploeh
Copy link
Owner

ploeh commented Dec 21, 2019

A blog post is, in many ways, anchored in time. Sometimes, however, I feel that I need to make changes to a post.

For some time, I've made use of the semantic markup elements del, ins, and so on. Deletions are fairly easy for the reader to detect, because they're decorated with the strikethrough style, but I explicitly removed the underline decoration from inserts because I thought it made the text harder to read.

Since I started to use those semantic markup elements, I've made an effort to include the datetime attribute.

It'd be nice if any semantic element that comes with a datetime element would display a tool tip when you hover over it. Something like added December 18, 2019, 11:27 UTC.

For additions (<ins>), it'd also be nice if there was some none-intrusive hint that this text is a bit different. Perhaps a slightly shaded background colour...

@TysonMN
Copy link
Sponsor Contributor

TysonMN commented Jun 15, 2020

I like how StackOverflow and GitHub handle this problem, which is by linking to the revision history of the question/answer/comment with the link text being the time of the most recent edit.

My first thought to achieve this behavior on your blog is to link to the revision history of the file in question. However, that history would include non-content changes from added comments and site-wide changes.

So my next thought is to link to a manually built page where you list only the commits that changed content. This seems reasonable to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants