Skip to content

docs(dev/AppConfig): re-organize, expand, update, and improve clarity - #14111

Merged
joshtrichards merged 1 commit into
masterfrom
jtr/dev-appconfig-ch-edits
Mar 9, 2026
Merged

docs(dev/AppConfig): re-organize, expand, update, and improve clarity#14111
joshtrichards merged 1 commit into
masterfrom
jtr/dev-appconfig-ch-edits

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Mar 6, 2026

Copy link
Copy Markdown
Member

☑️ Resolves

  • Re-organized for more logical flow
  • Fixed some typos
  • Added clarifications for consuming the APIs (in particular between the two inter-related IAppConfig APIs)
  • Added missing method(s)
  • Expanded coverage of typed config values and specifically:
    • migrating (reading / get*)
    • migrating (writing / set*)
  • Expanded coverage of lazy loading and specifically:
    • "Choosing what should be lazy"
    • "Reading behavior with lazy parameter"
  • Updated code examples

Related/follow-up items:

🖼️ Screenshots

image

Signed-off-by: Josh Richards <josh.t.richards@gmail.com>

@come-nc come-nc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We may want to make it more obvious the function names are different in the scoped version, because all examples use the other version currently, while the scoped one should be the most used by apps.
But that’s already an improvement anyway.

@joshtrichards

Copy link
Copy Markdown
Member Author

Agreed, but maybe a later pass. ;-)

Might also be made clearer through some re-org work on the Dev Manual overall:

i.e. stuff everyone needs to know, stuff app developers needs to know, stuff server/core developers need to know

Which I know is already partially how it's organized, but could use some clean-up (just do to where things have ended up over time).

@joshtrichards
joshtrichards merged commit e5d1abc into master Mar 9, 2026
11 checks passed
@joshtrichards
joshtrichards deleted the jtr/dev-appconfig-ch-edits branch March 9, 2026 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants