-
-
Notifications
You must be signed in to change notification settings - Fork 98
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.
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
1
commit into
racket:master
Choose a base branch
from
samth:browser-support
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
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.
There was a problem hiding this comment.
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)