This page is part of the ongoing DocumentationDiscussion
WikiGardening required. This document was (roughtly) cut out of DocumentationDiscussion and could use a good scrubing down.
So now what?
How do we move forward from here? It seems like the general consensus is that creating a better system for browsing/searching the online documentation is something we’d want.
I think this would stand a bigger chance of success if a few interested people got together and started sharing actual implementation ideas with each other, then the chance of one single person getting tired of it all and putting it to rest is smaller. Who wants to join The Rails Documentation Project? ;)
LeeO writes: I agree. I’ve put together a proof-of-concept (to teach myself some xml parsing) where the XML produced by rdoc was used to create AR records. It’s ugly but it’s a start. Reflecting on the decisions that I made putting it together, I think the sober first step is some planning. Or maybe soliciting members, then planning?
Further, I think we have to determine what information is needed from rdoc, and how to go about getting it…
What do we need?
- A plan!
- What are the requirements?
- What is the scope?
- What should the models look like?
- are we building a framework for all ruby documentation, or just for rails (am I getting ahead of myself? We can always extract later, I guess. — LeeO)
- What does the UI look like?