From cb0fd64084a6602cdc1fc81ce2138d03ae819e2c Mon Sep 17 00:00:00 2001 From: Sam Tobin-Hochstadt Date: Mon, 1 Jun 2020 17:01:04 -0400 Subject: [PATCH 1/2] Add browser support policy for Scribble-generated documentation. --- scribble-lib/scribble/browser-support.md | 41 ++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 scribble-lib/scribble/browser-support.md diff --git a/scribble-lib/scribble/browser-support.md b/scribble-lib/scribble/browser-support.md new file mode 100644 index 0000000000..b55ec5d4f0 --- /dev/null +++ b/scribble-lib/scribble/browser-support.md @@ -0,0 +1,41 @@ +## 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 +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. + +- Partial support includes any browser released within the past 5 + years with at least 1% use on https://docs.racket-lang.org As of + June 1, 2020, that includes the above browsers only. + + Note that the only browser not in the above set with more than 1% + share is Chrome 38 as distributed on the Nexus 5, which was + discontinued in March 2015. + +- Minimal support applies to all widely-distributed browsers. That is, + it is important that the text of the documentation appears in Links, + IE 6, Opera Mini, etc. + From 2ac10add0406c8a60ffde0bbbc591a27875b193e Mon Sep 17 00:00:00 2001 From: Sam Tobin-Hochstadt Date: Sat, 27 Jun 2026 12:01:14 -0400 Subject: [PATCH 2/2] scribble browser-support: drop IE6 target, cover text-mode browsers Addresses review feedback on #240: IE 6 can no longer establish a modern TLS connection to the docs site, so it can't load the pages at all (sorawee); replace it as the minimal-support target with text-mode browsers like lynx/links and screen readers (LiberalArtist). Also generalize the stale June-2020 usage-share example. --- scribble-lib/scribble/browser-support.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/scribble-lib/scribble/browser-support.md b/scribble-lib/scribble/browser-support.md index b55ec5d4f0..3dd9a248bc 100644 --- a/scribble-lib/scribble/browser-support.md +++ b/scribble-lib/scribble/browser-support.md @@ -28,14 +28,16 @@ styling or links) may be missing. shipped to users within the past 12 months, it is fully supported. - Partial support includes any browser released within the past 5 - years with at least 1% use on https://docs.racket-lang.org As of - June 1, 2020, that includes the above browsers only. - - Note that the only browser not in the above set with more than 1% - share is Chrome 38 as distributed on the Nexus 5, which was - discontinued in March 2015. - -- Minimal support applies to all widely-distributed browsers. That is, - it is important that the text of the documentation appears in Links, - IE 6, Opera Mini, etc. - + 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.) +