Skip to content

fix(fallbacks): clarify API docs and release workflow#42

Merged
caio-pizzol merged 1 commit into
mainfrom
caio-pizzol/readme-api-cleanup
Jun 5, 2026
Merged

fix(fallbacks): clarify API docs and release workflow#42
caio-pizzol merged 1 commit into
mainfrom
caio-pizzol/readme-api-cleanup

Conversation

@caio-pizzol
Copy link
Copy Markdown
Contributor

Clarifies the public docs around the 0.2 fallback API and removes stale wording from the package README.

Why:

  • the docs should lead with the three supported use cases: render a family, explain a decision, and create a resolver map
  • public wording should describe supported runtime files instead of internal measurement details
  • release should run automatically when releasable commits land on main, while keeping manual dry-run support

Verified:

  • bun run check
  • stale API scan for getFallback, deriveFallbackMap, hasFamily, and faithful

@caio-pizzol caio-pizzol force-pushed the caio-pizzol/readme-api-cleanup branch from a936734 to 0b906d3 Compare June 5, 2026 21:03
@caio-pizzol caio-pizzol merged commit cab3242 into main Jun 5, 2026
1 check passed
@caio-pizzol caio-pizzol deleted the caio-pizzol/readme-api-cleanup branch June 5, 2026 21:03
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.

2 participants