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

Spontaneous feedback on documentation #615

Open
leplatrem opened this issue May 24, 2024 · 1 comment
Open

Spontaneous feedback on documentation #615

leplatrem opened this issue May 24, 2024 · 1 comment

Comments

@leplatrem
Copy link
Contributor

From @lissyx

is this the right channel if i need to work around remote settings (adding new things that relies on it) ?

#delivery vs. #remote-settings :/

Firefox source docs

https://firefox-source-docs.mozilla.org/services/settings/index.html#usage =>

Uncaught Error: ChromeUtils.import is called against an ES module script (resource://services-settings/remote-settings.sys.mjs). Please use ChromeUtils.importESModule instead (SyntaxError: import declarations may only appear at top level of a module)
Screenshot 2024-05-24 at 17 04 37
  • Lack of clarity on when to use .get() vs. on("sync", ...)

is there a better API entry point documentation than https://firefox-source-docs.mozilla.org/services/settings/index.html#usage ? it's a bit hard to grasp a high-level view of the API surface to interact

read the docs

some info is spread like https://remote-settings.readthedocs.io/en/latest/getting-started.html should probably be a starting point, but it's burried inside firefox-source-docs

ok so the extension has a "local" setting, but i cannot find anything explaining how to run a local server

"dev" and "dev (preview)" in the extension, i dont see that mentionned anywhere?

this is outdated? https://remote-settings.readthedocs.io/en/latest/tutorial-dev-server.html#prepare-the-client the issue linked is closed now

Screenshot 2024-05-24 at 17 03 02

Screencasts

Videos don't show the new UI

Screenshot 2024-05-24 at 16 59 22

the button appeared? can't tell if it's because of a delay or just i force-reloaded the page

@leplatrem leplatrem changed the title Spontaneous feedbak on documentation Spontaneous feedback on documentation Sep 19, 2024
@leplatrem
Copy link
Contributor Author

Screenshot 2024-10-11 at 15 26 52

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant