Skip to content
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

Expand userstyle docs #311

Merged
merged 4 commits into from
Aug 3, 2023
Merged

Expand userstyle docs #311

merged 4 commits into from
Aug 3, 2023

Conversation

WorldLanguages
Copy link
Member

@WorldLanguages WorldLanguages commented Mar 13, 2023

Some TODOs below. Some of these would belong in the _index.md file - while others should be considered best practice or debugging tips.

  • Document addon settings CSS variables
  • Examples on how to use customCssVariables (there's some info already on the manifest doc - probably needs its own page?)
  • Document how addons should implement dark mode
  • Document typical usages of userstyle.if in manifests
  • Document updateUserstylesOnSettingsChange in more detail
  • Write a small guide on z-index and the current values used by addons, specially editor ones
  • Document browser support and CSS features that we can't use yet
  • Document .sa-body-editor
  • Document that CSS selectors should not target hashed class names
  • More details on specificity, addon.json order, and usage of !important
  • Document that certain languages can have longer strings for UI elements, so that needs to be accounted for in some cases
  • Add examples on how to support RTL in the project editor
  • Explain in detail the purpose of injectAsStyleElt and document %addon-self-dir%

@WorldLanguages
Copy link
Member Author

@mxmou I'd appreciate if you could think of other things that are worth documenting. Also, feel free to edit the files directly on this branch, if you find yourself in a writing mood (I admit it's not easy to write docs "from scratch")

@WorldLanguages WorldLanguages marked this pull request as draft March 13, 2023 15:45
@Hans5958 Hans5958 added type: enhancement New feature or request scope: docs Related to the documentation (Scratch Addons Docs) labels Mar 14, 2023
@WorldLanguages
Copy link
Member Author

The current userstyle docs (master branch) are almost non-existent, so I'll merge this progress very soon.

@WorldLanguages WorldLanguages marked this pull request as ready for review August 3, 2023 01:38
@WorldLanguages WorldLanguages merged commit 2c9395b into master Aug 3, 2023
3 checks passed
@Hans5958 Hans5958 deleted the new-userstyle-docs branch August 27, 2023 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Related to the documentation (Scratch Addons Docs) type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants