1975310 - Create documentation for Config-based preferences

Status: RESOLVED FIXED

(Firefox :: Settings UI, task)

Description

[Mark Striemer [:mstriemer]]

We should create some documentation for the Config-based Settings initiative. These docs should outline:

• How to convert an existing setting to the system (temporary)
• How to use the system to add settings
• Examples of config-based settings
• APIs of relevant objects (or links to searchfox docs in-tree)

For the time being, it likely makes sense to write this in a gdoc for simplicity of keeping them up-to-date as the project unfolds. In the future they should be moved to Firefox Source Docs (without the how to convert an existing setting section)

Comment 1

[Mark Striemer [:mstriemer]]

There's initial documentation in https://docs.google.com/document/d/1aONk8PLlGdDhj7LiEDeDHvMLboPrgkiXEesy14qHe_M/edit?tab=t.0#heading=h.z4zel1ko3j1z which will continue to be updated as we go

Comment 2

[Stuart Colville [:muffinresearch]]

Filed Bug 1990787 to commit the docs once they're complete and closing this out.

Comment 3

[Mark Kennedy [:mark]]

Attachment: Bug 1975310 - Fix addSetting.set return type r=mstriemer,Gijs

Comment 4

[BugBot [:suhaib / :marco]]

A patch has been attached on this bug, which was already closed. Filing a separate bug will ensure better tracking. If this was not by mistake and further action is needed, please alert the appropriate party. (Or: if the patch doesn't change behavior -- e.g. landing a test case, or fixing a typo -- then feel free to disregard this message)

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/8282c6c88a7b
https://hg.mozilla.org/integration/autoland/rev/d3aecbce7552
Fix addSetting.set return type r=mstriemer,Gijs

Comment 6

[amarc]

https://hg.mozilla.org/mozilla-central/rev/d3aecbce7552