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

Update addon.tab API Docs #499

Merged
merged 6 commits into from
Jan 5, 2025
Merged

Conversation

@Samq64 Samq64 added the scope: docs Related to the documentation (Scratch Addons Docs) label Oct 16, 2024
**In most cases, you should use the [`userscripts` property of the addon manifest](/docs/reference/addon-manifest/#userscripts-and-userstyles) instead.**

{{< admonition warning >}}
In most cases, you should use the [`userscripts` property of the addon manifest](/docs/reference/addon-manifest/#userscripts-and-userstyles) instead.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we officially deprecate this and also mention not importing 3rd-party libraries with it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but we could write down that usually we prefer addons that don't import any libraries.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In most cases, you should use the [`userscripts` property of the addon manifest](/docs/reference/addon-manifest/#userscripts-and-userstyles) instead.
Use the standard browser import instead.

Copy link
Member Author

@Samq64 Samq64 Oct 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but we could write down that usually we prefer addons that don't import any libraries.

I think that fits better in the best practices page and I want to try to keep this PR to just the API.

Copy link
Member

@Hans5958 Hans5958 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good for now, or is there anything that is subject to change?

@Samq64 Samq64 merged commit 34315ac into ScratchAddons:master Jan 5, 2025
4 checks passed
@Samq64 Samq64 deleted the api-doc-updates branch January 5, 2025 13:17
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)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update displayNoneWhileDisabled docs
4 participants