Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to document the archetypes #19

Open
nsryan2 opened this issue Jun 19, 2024 · 1 comment
Open

How to document the archetypes #19

nsryan2 opened this issue Jun 19, 2024 · 1 comment
Assignees
Labels
Documentation Improvements or additions to documentation

Comments

@nsryan2
Copy link
Member

nsryan2 commented Jun 19, 2024

There needs to be some commitment to how this will be documented. I think it will be a little hodgepodge, but the plan is to use very descriptive README's and example notebooks.

This issue can be closed with a clear, well-documented decision on how information will be stored in this repo.

@nsryan2 nsryan2 self-assigned this Jun 19, 2024
@nsryan2 nsryan2 moved this to Todo in NRyan_ORNL_24 Jun 19, 2024
@nsryan2 nsryan2 added the Documentation Improvements or additions to documentation label Jul 11, 2024
@nsryan2
Copy link
Member Author

nsryan2 commented Jul 29, 2024

As these archetypes piggy-back off of the Cycamore Reactor, we will reference the existing documentation (https://fuelcycle.org/user/cycamoreagents.html#cycamore-reactor) as the majority of the features are the same. The new features will be documented through the READMEs and with example notebooks.

@nsryan2 nsryan2 moved this from Todo to In Progress in NRyan_ORNL_24 Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant