Navigation with Updates

[Enegnei]

I've opened this issue to ask how easy it is for you (readers) to find new information in my investigation. Even though every commit is highlighted in the History, I don't know whether readers use that to find new information or if you just scroll through the article looking for parts that seem new. I would appreciate if I could get a few responses on one or more of these questions:

1) How do you find new information/ updates that I add? How easy are they to find?
2) Do you think I should make it easier to find these new/ updated sections?

Since it's Git, just use the Git history. Why fight it? To help people who aren't familiar with Git, you could put a link inside the text along with instructions and an explanation of what people will be seeing there.

It's not an ideal answer from a UX standpoint, but anything else will involve endless curation.

[Enegnei]

I've been thinking of maybe having a small section at the top of the page which lists the latest updates of that week, linking to sub-headers if it's several paragraphs or a new section, such as:

Latest updates: Tor Project concludes investigation, "Sam" story, Tor shares company policies

From there they can just do a keyword search if there isn't a sub-header link. But yeah I agree using History is the preferred option, that's what I would do. I just want to know if readers are doing the same.

[ralphtheninja]

@Enegnei Many open source projects have some sort of CHANGELOG document which is used to highlight things that changed but on a higher level, instead of going into details. So it could say "Added section blabla, removed thisandthat" etc.

[shannoncunningham]

I've been using the History tab, but it def. is more of a pain than
Wikipedia…

I've been thinking of maybe having a small section at the top of the
page which lists the latest updates of that week, linking to
sub-headers if it's several paragraphs or a new section, such as:

LATEST UPDATES: Tor Project concludes investigation, "Sam" story,
Tor shares company policies

Something like this would be great, if it isn't much trouble to do… I
just appreciate that the resource exists at all, so I certainly can't
complain. :)

[Enegnei]

@shannoncunningham Thanks for the input! It wouldn't be much trouble at all to do.

[Enegnei]

I've now added a "Latest updates" section at the top of the page under the table of contents: https://github.com/Enegnei/JacobAppelbaumLeavesTor/blob/master/JacobAppelbaumLeavesTor.md#latest-updates. It links to the header or subheader closest to where the change was.

[jeroenh]

First of all, I subscribed to the issues, but now see that you've done a lot more than is seen here.

Second, thanks for the latest updates addition! Unfortunately the links don't work, at least not on iOS.

[Enegnei]

@jeroenh Oh, that's unfortunate. I haven't used GitHub on Mac or iOS so I wouldn't have caught that. So the shortcut links I have in the table of contents also don't work on iOS?

[jeroenh]

@J9Roem that's correct, they don't work. They just link to the top of the file.

The links work OK on my Mac with OS X 10.10.5. Perhaps it is just an iOS problem.

[Enegnei]

@jeroenh Does iOS normally work with internal shortcut links? For example: https://en.wikipedia.org/wiki/GitHub#Gist

[jeroenh]

@J9Roem that Wikipedia link does work. So it seems to be something with the way the targets are defined.

[Enegnei]

@jeroenh Hmm, okay. No way for me to fix that, would have to be done on the iOS-end. This may be a use case for creating a webpage with GitHub Pages.