search

techhat / openrecipeformat

Specs and Examples for the Open Recipe Format
Other
140 stars 29 forks source link

Problems with navigation (reaching examples) #2

Closed matkoniecz closed 9 years ago

matkoniecz commented 9 years ago

As I understand http://open-recipe-format.readthedocs.org/en/latest/index.html is intended starting point for exploring this format definition. But from this page it is impossible to reach examples ( https://github.com/techhat/openrecipeformat/tree/master/examples ).

techhat commented 9 years ago

This is by design. Files in the examples/ directory are meant to be used to build parsers, not as documentation.

matkoniecz commented 9 years ago

Maybe it can be reconsidered, bread example was for me quite useful.

techhat commented 9 years ago

Well, the examples directory doesn't tell you how to do anything, it only provides examples that fit the spec.

The walkthrough does discuss how to do things, and it is available on RTD:

http://open-recipe-format.readthedocs.org/en/latest/topics/tutorials/walkthrough.html

I think it could be expanded, but for what you're looking for, that's probably a better direction.