Login

    Register

Managed Hosting

PROJECT CATEGORIES

 

Hyrule
Project Home Known Issues Contact Project

Hyrule Issue: Documentation could be friendlier

Name: Documentation could be friendlier
ID: 5
Project: Hyrule
Type: Enhancement
Area: Documentation
Severity: High
Status: Fixed
Related URL:
Creator: Raymond Camden
Created: 04/05/10 12:10 PM
Updated: 04/29/10 9:00 PM
Description: So I'm reading the docs for Hyrule and it goes from installation to a long list of constraints. Where is the sample code? The list of constrains is certainly important, but shouldn't you start off with an example of how one would use Hyrule? In fact, scanning the doc, I don't see that anywhere.
History: Created by cfjedimaster (Raymond Camden) : 04/05/10 12:10 PM

Comment by cfjedimaster (Raymond Camden) : 04/05/10 12:12 PM
As just a comment to this, the Samples dir _does_ provide nice examples, but I think most users will begin with the documentation under the /Docs folder. They may assume the samples are also poorly documented.

Comment by danvega (Dan Vega) : 04/29/10 8:59 PM
Cleaned up the docs a little and added a usage section.

Updated by danvega (Dan Vega) : 04/29/10 9:00 PM

To add a comment to this bug, please login using the link above.