Category:New documentation structure and items

From YADE

Proposal for the lvl2 guide : (find a better name)

VR Maybe should we split the following items in two groups: "Yade for beginners" and "Advance Yade usage"? /VR

- Downloading/compiling Yade

- Documentation (J. Duriez's begginers guide, wiki, doxygen + doxygen commenting convention) and how everybody can improve it.

VR - Yade main concepts /VR

- Creation of new classes and usage of SVN (I see people modifying existing classes to do what they want, best way to stop updating/commiting).

- Gui Interface

- Python console and scripts

- The logic of Sconscripts

- Kdevelop/CTags and perhaps more tricks to navigate in the code

- debuging tools

- usage of log4cxx

- bug tracking (?)

- Parallelization

- Profiling

Things that are not documented enough in current wiki, or not documented at all :

- Numerical scheme : the finite difference integration loop (you can't understand the code if you don't understand the theoretical background)

- Contact-logic : how interactions are created/deleted. We have a page for this but it needs cleanup.

Proposal for Yade Main page :

Starting from the current page :

-Add one or two beautifull images

-One BIG link to the main documentation page (itself pointing to JD. beginners guide, lvl2 guide, a structured list of wiki pages, a link to doxygen doc so you can browse/link Yade code in the wiki itself)

-Pros/cons : should it be on the first page?

General suggestions

-This website is good looking and the documentation is clear, it can give ideas : CGAL.

VR I'm not sure it is as clear as you say. But it is clear that it is complet and usefull! \VR