Skip to content

docs: split EXAMPLES.md into examples/ folder by feature #1062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
subhankarmaiti merged 4 commits into from
Aug 28, 2026
Merged

docs: split EXAMPLES.md into examples/ folder by feature #1062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1007dd9
docs: split EXAMPLES.md into examples/ folder by feature
subhankarmaiti Aug 27, 2026
f02c0e4
Merge remote-tracking branch 'origin/main' into docs/agent-friendly-e…
subhankarmaiti Aug 28, 2026
6edeabb
docs: fix broken snippets and links in examples
subhankarmaiti Aug 28, 2026
8172d53
docs: correct MFA getAuthenticators snippet for enroll flow
subhankarmaiti Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ Auth0.Android/
├── gradle/versioning.gradle # Reads version from .version
├── .github/workflows/test.yml # CI: tests + lint + coverage
├── .version # Single version source of truth
├── README.md / EXAMPLES.md # User-facing docs
├── README.md # User onboarding and requirements
├── EXAMPLES.md # Index linking to examples/
├── examples/ # Usage patterns, one file per feature
└── V4_MIGRATION_GUIDE.md # v3 → v4 migration
```

Expand All @@ -57,7 +59,7 @@ Auth0.Android/
- Provide both callback and `suspend` variants for every async public method (Java consumers need callbacks)
- Declare explicit visibility modifiers and return types on all public declarations (`-Xexplicit-api=strict` — CI fails on implicit visibility)
- Use specific exception types (`AuthenticationException`, `CredentialsManagerException`, `DPoPException`) — never bare `catch (Exception e)`
- Update `README.md` and `EXAMPLES.md` in the same PR when changing public API, configuration, or integration patterns — `EXAMPLES.md` must include Kotlin callback, coroutine, and Java samples for every async method
- Update `README.md` and the relevant file under `examples/` in the same PR when changing public API, configuration, or integration patterns — examples must include Kotlin callback, coroutine, and Java samples for every async method
- Route new outbound requests through `RequestFactory` so they carry the `Auth0-Client` header via `Auth0UserAgent` — don't create a separate HTTP client
- Keep `.version` as the sole version source of truth (injected via `gradle/versioning.gradle`)

Expand Down Expand Up @@ -130,6 +132,6 @@ A PR touching public API, config, or integration patterns is not complete until
| Doc | Covers |
|-----|--------|
| `README.md` | Installation, requirements, quick-start, config |
| `EXAMPLES.md` | Full Kotlin + Java usage for every feature |
| `EXAMPLES.md` + `examples/` | `EXAMPLES.md` is an index; each feature has its own file under `examples/` with full Kotlin + Java usage |

See [references/docs-update.md](references/docs-update.md) for the full code-to-docs mapping. Read before finalizing any public API PR.
Loading
Loading