docs: group browser API pages into a Browser APIs section#5647
Draft
mcollovati wants to merge 4 commits into
Draft
docs: group browser API pages into a Browser APIs section#5647mcollovati wants to merge 4 commits into
mcollovati wants to merge 4 commits into
Conversation
The Flow Advanced Topics section had grown into a catch-all of ~31 unrelated pages, making cohesive browser/web-platform API references (Clipboard, Geolocation, Page Visibility, Wake Lock, History, Fullscreen, Web Storage) hard to find. Move those seven pages into a new Browser APIs section placed right after Forms & Data Binding, ordered alphabetically by title, and update the History API cross-reference in Updating URL Parameters to point at the new location.
Preview DeploymentThis PR has been deployed for preview. URL: https://docs-preview-pr-5647.fly.dev Built from 041a505 |
Pages under the new Browser APIs section repeated "API" in their navigation titles (Clipboard API, Geolocation API, and so on), duplicating the section name. Shorten each subsection title to just the feature name (Clipboard, Geolocation, History, ...). The in-page headings and SEO page titles keep the full "... API" name for clarity and search.
The main heading on each Browser APIs page still repeated "API" (Clipboard API, Geolocation API, and so on), duplicating the section name. Shorten each page heading to the feature name, preserving the version badges on Fullscreen and Page Visibility.
These three Browser APIs pages lacked the version badge that Fullscreen and Page Visibility already had, even though all were introduced in the same release. Add the [since:com.vaadin:[email protected]] marker to their headings for consistency.
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
1 participant
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.
The Flow Advanced Topics section had grown into a catch-all of ~31 unrelated pages, making cohesive browser/web-platform API references (Clipboard, Geolocation, Page Visibility, Wake Lock, History, Fullscreen, Web Storage) hard to find.
Move those seven pages into a new Browser APIs section placed right after Forms & Data Binding, ordered alphabetically by title, and update the History API cross-reference in Updating URL Parameters to point at the new location.