Improve browsing of release notes and try.squeak.org integration - #70
Merged
Conversation
…ks and their limitations and refers to the download page and try.squeak.org Depends on squeak-smalltalk/try.squeak.org#2.
- For collection items, do not include order number in theeir ID. This is required for the previous commit, which requires stable download links. Titles should be unique anyway. - Use modern scroll-margin-top instead of auxiliary anchor divs
…ueak on try.squeak.org Also open links in demo mode of try.squeak.org and navigate to release notes in support images.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves on-site browsing of release notes and strengthens integration with try.squeak.org by modernizing anchor behavior (moving ids onto headings) and adding a dedicated release-note header with “Download” / “Try in browser” actions.
Changes:
- Replace legacy
<span class="anchor">anchors with elementidanchors and a CSSscroll-margin-topoffset. - Add a release note header include + new
release_notelayout and set it as the default layout for therelease_notescollection. - Update the
code:URL rewriter to generate try.squeak.org URLs with updated parameters and version-specific behavior.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
index.html |
Moves section anchors onto headings for home page sections. |
_sass/custom.scss |
Replaces .anchor offset hack with scroll-margin-top and adds release-note header styling. |
_release_notes/_note_head.html |
Adds release note header content and try.squeak.org / downloads actions. |
_plugins/code_links_rewriter.rb |
Updates code: link rewriting to new try.squeak.org URL format and version-dependent behavior. |
_layouts/section.html |
Moves category anchors onto <h2> ids. |
_layouts/release_note.html |
New release-note layout that injects the release-note header above content. |
_includes/item_with_img.html |
Moves per-item anchors onto <h3> ids (image/icon items). |
_includes/item_text_only.html |
Moves per-item anchors onto <h3> ids (text-only items) and tweaks “Read on” link text. |
_config.yml |
Switches release notes default layout from default to release_note. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Warning
Breaking change: The old numbered text anchors like
#opensmalltalk-vm-100for ordered collection items are no longer available but have been replaced by unnumbered annchors like#opensmalltalk-vm. For most affected pages such as/communityor/features, this does not really matter as these pages are effectively so short that the relevant item will appear immediately anyway. For/documentationand/downloads, this might be most noticable as these pages are longer. However, these anchors have been never stable anyway, because every addition of a newer book or version of Squeak in the past has changed the anchors anyway. Offering backwards compatibility seems pointless for this reason.Depends on squeak-smalltalk/try.squeak.org#2.
Note: I'm mainly creating these PRs for structuring my changes, for running CI & Copilot reviews on them, and for transparency. I don't really need or are waiting for a review, even though feedback is always welcome :)