Skip to content

Add browser support policy for Scribble-generated documentation. #240

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.

Sign up for GitHub

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

Open
samth wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add browser support policy for Scribble-generated documentation. #240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb0fd64
Add browser support policy for Scribble-generated documentation.
samth Jun 1, 2020
2ac10ad
scribble browser-support: drop IE6 target, cover text-mode browsers
samth Jun 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions scribble-lib/scribble/browser-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Scribble Browser Support Policy

This document describes the intended browser support range for HTML
manuals generated with `#lang scribble/manual`.

This policy defines three levels of support:

- Full support (all features).
- Partial support (documentation features)
- Minimal support (reading documentation text)

Any feature must work correctly in all browsers with full support.

Features that are not needed for reading and understanding the
documentation, but that are intended for developers of the
documentation or other specialized audiences, such as links to

@jackfirth jackfirth Jun 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"such as links to implementation" - is this the motivating use case for this pull request? (Just curious)

implementation, may not work in browsers with only partial support.

For browsers with minimal support, it will be possible to read the
text of the documentation, but all other features (such as proper
styling or links) may be missing.

#### Currently supported browsers

- All "evergreen" browsers current within the past 12 months (this
includes Chrome, Firefox, Safari, Edge, and other regularly-updated
browsers based on similar). "Current" means if that browser was
shipped to users within the past 12 months, it is fully supported.
Comment on lines +25 to +28

@LiberalArtist LiberalArtist Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intention that this should include supported Firefox ESR releases, since they get point releases (that are not feature updates) more than once per year? https://support.mozilla.org/en-US/kb/firefox-esr-release-cycle


- Partial support includes any browser released within the past 5
years with at least 1% use on https://docs.racket-lang.org. In
practice this is usually the same set as the fully-supported
evergreen browsers; the current usage share should be consulted when
deciding whether a specific older browser still qualifies.

- Minimal support applies to all widely-distributed browsers that can
reach the documentation. That is, it is important that the text of
the documentation is readable in text-mode browsers such as `lynx`
and `links`, in screen readers, and in other browsers with limited
styling or scripting. (Very old browsers that can no longer establish
a modern TLS connection to the documentation site, such as IE 6, are
out of scope: they cannot load the pages at all.)
Comment on lines +40 to +42

@LiberalArtist LiberalArtist Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not against declaring IE 6 out of scope, but the TLS criterion is about accessing documentation over the network. Isn't IE 6 still able to load locally-installed documentation pages?