[Feature] Improve documentation for database types and how they are generated and documented.
@dean-krueger is already working on this.
Since May 18, 2026.
Assessment
This issue has not been assessed yet.
Description
What is the motivation for your feature request? Please describe what you want to use it for.
The process of adding new compound/complex data types to the database backends, for use by archetype developers, is arcane and poorly documented. The documentation does provide a list of available database types, but little about how to add new ones.
Describe the feature you'd like.
Add a page to the archetype developers guide that descibes:
- how to add new data types
- the various ways those data types are automatically processed and why
Describe alternatives you've considered.
The alternative is that developers need to do a forensic code study to figure out what's going on (or ask an AI agent to help).
Additional context.
This may be a good task for pair-programming since the complexity of these processes may be understood more easily by multiple people sharing perspectives.
How can this issue be closed?
Add a page to the documentation that covers these topics.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cyclus/cyclus.github.com
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cyclus/cyclus.github.com#454 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 64/100
cyclus/cyclus.github.com#453 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
cyclus/cyclus.github.com#448 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
cyclus/cyclus.github.com#445 ·
-
[Task] Update tutorial files in Zenodo ObjectMay be free again @connor-welch claimed this 259 days ago, and no pull request is open. Open0 - Backlog
cyclus/cyclus.github.com#441 · 3 comments · 1 assignee ·
All issues in cyclus/cyclus.github.com
Similar issues
-
upstream update
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
conan-io/conan-center-index#31098 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
john-kurkowski/tldextract#382 ·
-
comp/tools duplicate P2 sweeper:risk-compatibility tool/mcp type/bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
NousResearch/hermes-agent#132042 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
deepset-ai/haystack#13092 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
feder-cr/invisible_playwright_mcp#1408 ·
Maintainers usually reply within 1 day