Skip to content

[codex] document preferences provider and formatAmount behavior#345

Open
Flamki wants to merge 1 commit into
Talenttrust:mainfrom
Flamki:docs/preferences-provider
Open

[codex] document preferences provider and formatAmount behavior#345
Flamki wants to merge 1 commit into
Talenttrust:mainfrom
Flamki:docs/preferences-provider

Conversation

@Flamki

@Flamki Flamki commented Jul 1, 2026

Copy link
Copy Markdown

What changed

  • Added docs/preferences.md covering the preferences model, defaults, STORAGE_KEY, hydration, persistence, safe storage behavior, theme application, system media-query handling, accessibility/contrast implications, and formatAmount branches.
  • Linked the new guide from README.md.
  • Added JSDoc pointers from PreferencesProvider and usePreferences() to the guide.

Closes #250

Validation

  • npm run lint failed on pre-existing issues outside this docs change:
    • src/components/ActionPanel.tsx: parse error at export default ActionPanel
    • src/components/__tests__/Breadcrumbs.test.tsx: missing testing-library/no-node-access rule
    • src/components/toast/toast-provider.test.tsx: unused wrappedDismiss
  • npm test -- --runInBand failed because ActionPanel.tsx cannot parse in two suites; 48 suites passed, including src/lib/__tests__/preferences.test.tsx.
  • npm run build failed because ActionPanel.tsx cannot parse.
  • npm test -- src/lib/__tests__/preferences.test.tsx --runInBand passed all 51 assertions, but Jest exited non-zero due existing obsolete snapshot files.

@drips-wave

drips-wave Bot commented Jul 1, 2026

Copy link
Copy Markdown

@Flamki Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Flamki Flamki marked this pull request as ready for review July 1, 2026 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the preferences provider, theme application, and formatAmount behavior

1 participant