cyclus/core — Issue #23: Intro Documentation Update
Author: rwcarlsen
Created: 2012-02-03 19:37:53+00:00
State: open

Target Date :
TBD

Feature Description :
I think there should be a single entry point for new developers. This entry point should direct the developer through a streamlined set of descriptions, explanations, instructions, and resources which fully equip them to be a cyclus developer. While we have a DevelopersDocumentation wiki page, the GettingAndBuildingCyclus wiki page, and other resources, a comprehensive list of useful resources and a directed path through them will help developers. Perhaps this will exist solely on the wiki in the Developers guide, or perhaps there should be a supplemental document. In any case, this task should ensure that there is a clear starting point and directed path through all introduction documentation on the wiki, documentation, Stub files, and paper resources intended for Developers.

Subtasks :
Describe tasks that are necessary for this feature to be implemented. If
there is an associated issue describing the subtask, report it as a related
issue below.

1. Decide on the essential information a developer needs to participate (resources, intros, stub files)
2. Put these resources in order of a coherent learning trajectory
3. Make certain that all elements of the website and documentation direct the new developer to a single starting point
4. Make certain that the starting point leads the developer through the learning trajectory in a straightforward way.

Comment 1 by project member Matthew.Gidden, Nov 21, 2011

I'm trying to think of basic things that a new developer would need to know. Immediately coming to mind is the process of building facilities at different times... I'm about to start trying to work on output, which only makes sense if we have that ability, so I can start writing as I go through that process.

Comment 2 by project member katyhuff, Nov 21, 2011

What do you mean by trying to work on output?
Do you mean pytables scripts to make graphs and whatnot or refactoring the BookKeeper?

Comment 3 by project member uwgonuke, Nov 21, 2011

Three different levels of documentation are indicated:
1. Getting Started: brief, lightweight tutorial for making a new facility (wiki)
2. Instructional guide: chart a path through the reference documentation that is designed to teach things in a carefully chosen order (wiki)
3. Doxygen as canonical reference documentation