Reference
Materials
A guided path into materials documentation with a clear handoff to the canonical schema docs and import reference.
Canonical reference
Materials docs hand off to the schema reference.
Use this page to understand how to approach materials documentation, then move into the canonical schema docs when you need exact import structure, examples, and troubleshooting.
Open schema docsContract-focused
The schema docs are the right place when field-level accuracy matters.
Import-oriented
They are designed for conversion, import, validation, and parity review work.
On this page
Materials overview
On this page
Materials overview
On this page
Materials overview
The materials area of the documentation should stay simple and clearly scoped.
Materials documentation in WEEMS is different from the broader workspace guides. It is less about general orientation and more about making sure users know where to find the exact reference they need for import and canonical schema work.
That is why this page acts as a structured handoff. It keeps the overall docs experience consistent while preserving the existing schema docs as the authoritative reference surface.
Product guidance
This page explains how materials documentation fits into the rest of the docs system.
Reference fidelity
The schema docs remain the place for exact field names, examples, and validation guidance.
When to use schema docs
Move into the schema reference whenever the work becomes contract-sensitive.
Use the schema docs when you need to understand canonical schema structure, conversion behavior, supported import flows, or detailed troubleshooting around material ingestion.
If the question is only about where materials fit in the product, this page is enough. If the question is about exact payload shape or conversion decisions, the schema docs should be the next stop.
Rule of thumb
The moment you start asking about exact fields, schema versions, conversion manifests, value kinds, or import troubleshooting, open the canonical schema docs.
Schema reference map
The existing schema docs already cover the most important reference paths.
Start here
Use this section when you need the top-level map of the schema and import flow.
Open start hereOverview and anatomy
Use these sections to understand the schema structure and why the canonical contract exists.
Open anatomyConversion playbook
Use the conversion guidance when preparing external data for import.
Open playbookExamples and troubleshooting
Use these sections when you need copy-ready examples or help diagnosing import issues.
Open troubleshootingRecommended path
A simple sequence keeps materials work easier to reason about.
Use this page to orient yourself
Start here when you need to understand where materials docs fit in the broader WEEMS documentation system.
Open the schema docs for exact rules
Move into the canonical schema reference for payload structure, conversion guidance, and examples.
Follow the relevant schema section
Use the section map above to go directly to anatomy, conversion, examples, or troubleshooting.
Return to product docs when the question becomes workflow-oriented again
Use the workspace docs for product behavior and the schema docs for contract behavior.
WEEMS Documentation
Product guides for projects, canvas workflows, and materials reference handoff.