Skip to content

docs-update.md

Latest commit

 

History

History
23 lines (15 loc) · 1.89 KB

docs-update.md

File metadata and controls

23 lines (15 loc) · 1.89 KB
Raw

Docs Update Rules — Code-to-Docs Mapping

Full mapping table. See CLAUDE.md for the tracked-docs inventory and the always-loaded "update docs in the same PR" boundary.

This is a library/SDK repo (public surface = exported classes/methods under com.auth0). Docs split into hand-maintained (safe to edit; in .fernignore) and generated (do not hand-edit).

When this changes Update these docs
Hand-maintained public API — Authentication API (AuthAPI, AuthorizeUrlBuilder, LogoutUrlBuilder, passwordless, token vault) README.md (Getting Started), EXAMPLES.md (relevant scenario section)
Client construction / options (ManagementApiBuilder, TokenProvider, ClientOptions, ProxyOptions, LoggingOptions) README.md (Configure the SDK), EXAMPLES.md (HTTP Client configuration / Management API usage)
New usage pattern or scenario (pagination, error handling, async, org login, ID-token verification) EXAMPLES.md (add/adjust the matching section)
Minimum Java version, install coordinates, or dependency changes README.md (Requirements / Installation)
A source- or binary-breaking change (approval required) v4_MIGRATION_GUIDE.md (current major), plus README.md/EXAMPLES.md for affected samples

Generated docs — do NOT hand-edit

  • reference.md — Management API code samples, generated by Fern. Regenerate; never patch by hand.

Release-flow docs — not touched per feature PR

  • CHANGELOG.md — updated by the release process, not as part of a feature PR (it is in .fernignore so it isn't regenerated, but it's owned by the release flow).

When you touch code that maps to a hand-maintained doc above, update that doc in the same PR — do not defer. README.md, EXAMPLES.md, and the migration guides are in .fernignore, so your edits persist across SDK regeneration.