-
Notifications
You must be signed in to change notification settings - Fork 20
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
Documentation improvements and corrections #88
Comments
I found this piece of code confusing, but it could still be useful to mention that properties need to be set on iframes' |
Although the vast majority of the UX can be ltr, I’m noticing that vertical writing + the toc panel is an open question BTW. In Requirements for Japanese Text Layout:
They just mention indexes for |
Add this warning about Mongolian directly in docs. |
I'm submitting an issue following some feedback from @mickael-menu
Short description of the issue/suggestion:
There are a few places in docs that could be improved or clarified.
Other information (e.g. related issues, suggestions how to fix, links for us to have context)
Here’s a list of things we could improve.
We should remove
|| document.getElementById("iframe-wrapper").contentWindow.document.documentElement
since it doesn’t add much to it, implementers dealing with iframes know they are using an iframe and the context is thecontentDocument
anyway.For
default.css
we should make it clear inlinestyle=""
should be checked in the entire DOM and not onlyhtml
orbody
.“Theme” is confusing in the User prefs doc as it’s used for multiple things. In addition it’s not super clear what sepia and night modes are compared to custom themes.
For the typeface names, we could mention this link to highlight it’s mapped on type classifications people use in typography. We could maybe even advise to use these names in the pref panel instead of hardcoded Font family names we are not sure are available on the platform.
The
typeScale
concept could probably be defined/described in a few sentences and illustrated by something like this web app: https://type-scale.comThere’s a mistake in the API Doc: font stacks are listed for
fontSize
.We should also add instructions for embedding fonts (and mentions of alternatives like google fonts, downloadable fonts on Android/iOS, etc.).
The text was updated successfully, but these errors were encountered: