bigdoods / ifc-tech.org

IFC website and documentation repo:
https://ifc-tech.org
Creative Commons Attribution 4.0 International
5 stars 3 forks source link

Remove tasks from documentation #22

Closed bigdoods closed 7 years ago

bigdoods commented 7 years ago

There will be a time that comes where there will be a need to divide the tasks and the tutorials. For now, there is no content to divide.

To Recap; as per the description in the site FAQ

A task is;

A task page shows how to do a single thing, typically by giving a short sequence of steps. Task pages have minimal explanation, but often provide links to conceptual topics that provide related background and knowledge.

A tutorial is;

A tutorial page shows how to accomplish a goal that is larger than a single task. Typically a tutorial page has several sections, each of which has a sequence of steps. For example, a tutorial might provide a walkthrough of a code sample that illustrates a certain feature of IFC. Tutorials can include surface-level explanations, but should link to related concept topics for deep explanations. 
bigdoods commented 7 years ago

A user-guide can be split up into tasks, tutorials and concepts in future when there is content.

bigdoods commented 7 years ago

New user-guides structure;

user-guides
├── Tutorials
└── Concepts