How to structure docs?

[billgathen]

Moving this discussion from the pull request into a dedicated location.

What should we rename the repo to? What belongs in it? Is it our official ruby information source?

[atkolkma]

I think we can just get all training topics into dedicated folders of this repo. If we later decide that cloning the whole repo is overkill for people working on specific topics, we can always partition each topic into its own repo.

[atkolkma]

There is one question we haven't addressed. Should the training/walkthroughs only serve as supplemental materials to the challenges, or be something in their own right? I mean, do we want to take the approach of having a "challenge driven curriculum", or should people be able to just explore introductory walkthroughs/tutorials on their own. The answer will largely determine the structure of our materials, I think.

[billgathen]

I think having a "challenges" directory (with explanatory text in the main readme) would be a good place to keep those, and each tutorial/walkthrough in their own dir?

I have some plans for handling the "teaching" part of the fizzbuzz challenge, but for now I think that would be a good start.

[atkolkma]

Sounds good, Bill. I started writing a comment to that effect, but wasn't sure what your vision of the curriculum was, so I didn't post it.

[billgathen]

It's a shared vision, Adam. That's the whole point of the exercise. 😉

Submit a pull request: everybody can weigh in and we'll figure it out. Concrete examples are much easier to talk about.

Also, the more times we change it, the more practice everybody gets with the workflow. Win, win.