cyclus / cyclus/cyclus.github.com

[Feature] Improve documentation for database types and how they are generated and documented.

Open
#437 0 comments 0 reactions 1 assignee View on GitHub

@dean-krueger is already working on this.

Since May 18, 2026.

Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

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:

  1. how to add new data types
  2. 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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.