Toolkit page needs an update

Open
#376 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, python
Domain
documentation

Research direction

Start with source/arche/toolkit.rst and compare the linked source/arche/tutorial_cpp/toolkit.rst and source/arche/tutorial_py/toolkit.rst pages. Add information for Material Buy Policy, Material Sell Policy, Total Inventory Tracker, Res Manip, and Timeseries, deciding whether the buy/sell policies need a separate linked page. Update both tutorials to link to the main toolkit page; the checklist should be complete when all requested information and links are present.

Written by the indexing model from the issue text.

Description

0 - Backlog

Cyclus Toolkit page is missing information on

  • Material Buy Policy
  • Material Sell Policy
  • Total Inventory Tracker
  • Res Manip
  • Timeseries

Buy/Sell policies might warrant their own page linked from within the toolkit page?

Also the archetype development tutorials (C++, python) should probably link to the main toolkit page

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

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.

More from cyclus/cyclus.github.com

All issues in cyclus/cyclus.github.com

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.