microsoft / ChakraCore-wiki

A mirror of the ChakraCore wiki to enable pull requests on the Wiki.
https://github.com/Microsoft/ChakraCore/wiki
Other
22 stars 30 forks source link

Replace Release Notes page with redirect to Release Notes section of Roadmap #40

Closed dilijev closed 7 years ago

dilijev commented 7 years ago

Alternative to #39

dilijev commented 7 years ago

Here are some alternatives we are discussing:

Option 1

Without the Release Notes header (and link anchor) the link from Release Notes to Roadmap will go to the top of the page, e.g. here: https://github.com/dilijev/ChakraCore-wiki/blob/f555ec272c91a3b635db91db15165ec2922edf77/Roadmap.md

Option 2

The link to Roadmap#release-notes will go to e.g. here (link from #39) https://github.com/dilijev/ChakraCore-wiki/blob/523afface5bdc1cc90f01f36c5f63e0c1bbe6212/Roadmap.md#release-notes (scrolled to Release Notes section).

Option 3

Other alternative suggested is to link to the most recent release as of now e.g. https://github.com/dilijev/ChakraCore-wiki/blob/f555ec272c91a3b635db91db15165ec2922edf77/Roadmap.md#chakracore-14

@liminzhu and I agree that between options 2 and 3, option 2 is better. Personally I think option 2 is best, and option 1 should be ruled out since it means having an empty H1 for Release Notes (as in this PR #40). Increasing the heading level of everything below it as in #39 adds to the organization of the page.

Linking to the top of the page is potentially confusing for someone looking for Release Notes, since that part of the page wouldn't even be in view when the page loads at the top.

@tcare Thoughts on which way is better?

Edit: Updated my opinion after further discussion with @liminzhu :)

dilijev commented 7 years ago

Screenshot to show the differences:

Left: TypeScript Middle: Option 2 with # Release Notes and ## ChakraCore 1.4 Right: Option 3 with # ChakraCore 1.4

Could also hybrid Option 2 link with Option 3 style by adding empty # Release Notes above # ChakraCore 1.4 but we (@liminzhu and I) feel that looks unbalanced.

image

/cc @tcare @liminzhu

tcare commented 7 years ago

2 or 3 is fine by me :)