The docs are split by who you are and what you are trying to do. Pick the directory that matches your goal.
| I want to… | Go to | Start with |
|---|---|---|
| Use XFTY to write tests for my code | use/ |
use/getting-started.md |
| Teach XFTY about my project's record types (write Providers, register variants, custom value expressions) | extend/ |
extend/README.md |
| Work on XFTY itself (architecture, tests, packaging, contributing) | contribute/ |
contribute/architecture.md |
| Look something up (breaking changes, platform constraints, open defects, the API list) | reference/ |
reference/ |
| See what's built, in progress, or proposed | roadmap/ |
roadmap/README.md |
| Read the thinking behind XFTY (the author's essays — background, not reference) | articles/ |
articles/README.md |
One page per feature, each opening with the simplest example and building up. See use/README.md for the reading order and the full feature matrix (every feature → its page → the test that proves its examples).
- Getting Started — the guided tour
- Generating & customizing: generating-records · override-templates · value-expressions · context-aware-values
- Relationships: relationships · per-call-relationships · shared-ancestors · bundles
- Persistence: insert-modes · deferred-insert
- provider-variants
- advanced/ — combining features
- Providers — support a new record type
- Provider Lookups — your project's registry
- Provider Variants — flavour keys; XFTY matches an override template to a registered variant automatically (only Apex's zero-setup schema detection is gone, see reference/known-issues.md)
- Custom Value Expressions
- Shared Ancestors in a Master Template
- The Bundled Providers — copy-and-adjust
- Coding Standards — the rules code is held to
- Architecture — the engine and why it is shaped this way
- Local Development — building, testing, coverage
- Test Suites — how the xUnit projects are organized
- Coverage Standards
- Packaging · CI
- Migration — every breaking change in this release
- Salesforce Considerations — what carries over from the Apex original, and what doesn't
- Volume & Limits — where generation gets expensive, and how the port measures it
- Known Issues — the short list of what XFTY can't do, each as "what you tried / what you got / what to do instead"
- API Cheat-Sheet — every public class and method, one line each
- Comparison — an honest feature comparison against AutoFixture, Bogus, AutoBogus, and NBuilder
roadmap/README.md is the status table, the decided
remaining work, and the ideas under consideration that aren't decided yet.
Detail pages (the former design/ proposals) sit beside it.
Three long-form essays by the author on the reasoning behind XFTY — where it came from, why isolated unit tests are worth the effort, and how to write them. Opinion pieces kept for background; articles/README.md has the reading order. Nothing else in the docs depends on them.