Contribution workflow
1
Edit the smallest relevant data file
Update the canonical object instead of copying the same information into multiple datasets.
2
Use stable IDs
Existing IDs should not be renamed casually because other records can reference them.
3
Add relationships explicitly
Connect a new topic or term through
relationships.json when a meaningful relationship exists.4
Validate locally
Run the repository validator before committing.
5
Preview documentation
If the change also touches MDX, preview Mintlify locally.
Pull request checklist
- No duplicate IDs
- No broken topic references
- Definitions are neutral and concise
- New public concepts have appropriate relationships
- URLs begin with
/when they reference internal documentation - No credentials, private keys, seed phrases, or private data