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

Docs headings and changelog refactor #5067

Merged
merged 5 commits into from
May 20, 2018

Conversation

GeoffreyBooth
Copy link
Collaborator

@GeoffreyBooth GeoffreyBooth commented May 14, 2018

This PR is meant to make #5058 easier.
https://rawgit.com/GeoffreyBooth/coffeescript/docs-headings/docs/v2/

  • The changelog entries are now split into separate files, and each one is in its own <section> tag like the rest of the docs’ sections; and they use h3 tags like the other sub-sections do. The HTML structure should be consistent now between sections like Breaking Changes and its children and Changelog and its children.
  • I made the dates in the changelog headings formatted in the user’s locale by default. So for US English users they appear the same as before, but a U.K. user should see e.g. “13 May 2018” and a French user “13 mai 2018”. @zdenko, if you have any devices with non-US locale settings, please let me know if it works for you 😄The formatting falls back to ISO, e.g. “2018-05-13”.
  • I added separate sidebar links for Introduction and Overview, so that the scrolling to those sections works as expected. This also simplifies the structure, as there aren’t any sections with two htmlFor calls (other than for children).

I considered making a sectionFor helper, to slim down body.html, but ultimately figured it would be more hassle than it’s worth because of the complexity of how to handle children. Hopefully this isn’t too hard to parse as is.

@zdenko
Copy link
Collaborator

zdenko commented May 20, 2018

LGTM

@GeoffreyBooth GeoffreyBooth merged commit 68302e6 into jashkenas:master May 20, 2018
@GeoffreyBooth GeoffreyBooth deleted the docs-headings branch May 20, 2018 16:39
@GeoffreyBooth GeoffreyBooth mentioned this pull request May 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants