cyclus / cyclus/cyclus.github.com

Does the Adding Regions and Institutions page need restructuring?

Open
#448 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently, the Adding Regions and Institutions page is structured differently than the other pages of the tutorial. The way the page presents the concepts of regions and institutions somewhat treats regions and institutions as two separate blocks, when in reality, institutions are a part of the Region block. For example, we provide partial templates for the region block and the institution blocks within the region block, and then show a combined region and institution block template. Do we want to keep the partial templates to help explain the concepts of regions and institutions, or get rid of them and use the full template to explain the concepts?

Additionally, the page has activities that:

  1. Write the Region Block
  2. Save the input file as tutorial_oncethrough.xml
  3. Add an extra institution into the Region Block
  4. Save the input file as tutorial_oncethrough.xml again

Is there value in having a separate activity to add an extra institution, or could that be done when the Region block is first written?

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.

Research direction

Review the Adding Regions and Institutions tutorial page alongside the other tutorial pages to understand the current structure and activity sequence. Decide whether the partial templates and separate institution activity should remain; the work is done when the page has an agreed structure and consistent activity flow.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.