How-to guides¶
Task-oriented recipes. Each one starts from a goal and ends with working code, rather than explaining a concept.
If you are new, read hello-dfc first.
Guides¶
| Guide | You want to |
|---|---|
| Build a catalog | Assemble organizations, products, and prices into a document |
| Read and validate JSON-LD | Take a document you did not write and trust what you get back |
| Handle identifiers | Choose @ids that survive re-export and stay resolvable |
| Work offline or on your own version | Control the context and vocabularies, with no network |
Concepts, not recipes¶
For why the connectors behave as they do, see concepts. The guides assume you have read the relevant concept page if the behaviour surprises you — most surprises trace back to context and versioning or relationships.
Migrating?¶
If you are moving from the original DFC connectors rather than starting fresh, read the migration guide instead. It maps the original API property by property and is the faster path.
Verifying the examples¶
The snippets in docs/getting-started/ are executed as tests in CI. The
snippets in these guides are not — read them as illustrations and check them
against the API reference, which is parsed from
the connector sources and cannot be wrong.