-
-
Notifications
You must be signed in to change notification settings - Fork 13
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
Reformat the doc structure #113
Comments
@RusinovAnton What do you think about some compatibility informations in the docs? My idea is to have it in a very simple form (no huge table etc.) like for example the |
The feedback I've got from people at reddit was mostly positive on what it is right now, but some people wanted it even terser - like the description text is redundant, so should be placed after the syntax definition or removed from the doc at all, looking into that I think the compatibility would be even more redundant for tl;dr. If people do not have automation that builds their bundle to be compatible we browsers they support and they care about it themselves I would suggest using https://caniuse.com/. Maybe we could come up with some solution that links our docs with caniuse? But anyways, that should be a separate task. Here I would like to discuss the feedback about two things we do have right now:
I'll update ticket text |
Since our text description usually just describes a syntax definition with words, we could remove most of the text by using JSDoc/Typescript typings for parameters definition, leaving just important notes / or non-obvious things, also moving them after the Syntax section
The text was updated successfully, but these errors were encountered: