Re: [Rails-devel] Documentation

[brett l. <wak...@gm...>]

I can enable a wiki, if people are interested in using it.

Secondary to that, I can start automatically generating the javadoc
and uploading it to the website.  I'll stick these on my todo list for
(hopefully) this weekend. :-)

---Brett.



On Wed, Feb 10, 2010 at 3:06 PM, Erik Vos <eri...@xs...> wrote:
> A wiki would be a very good idea. I can't set it up, though.
> In general, to any kind of documentation I'm willing to contribute, answer
> questions, and/or review other people's contributions.
> But I don't want to own it.
>
> Erik.
>
> -----Original Message-----
> From: Stefan Frey [mailto:ste...@we...]
> Sent: Wednesday 10 February 2010 23:12
> To: Development list for Rails: an 18xx game
> Subject: Re: [Rails-devel] Documentation
>
> I assume limited time is a common feature ;-)  and most of the time the best
>
> reason for missing documentation...
>
> As I had to get myself familiar with the code and structure, I put down some
>
> notes already, which would need some polishing for others to understand.
>
> My take on doc is:
> The best and up-to-date documentation of the code is the code itself.
> Improving the code improves the documentation. Second best for code
> documenation is adding documentation in Javadoc comments.
>
> For higher-level documentation (for rails e.g. how to prepare XML files,
> design tiles, build the project, user documentation etc.) I prefer wikis for
>
> joint projects.
> Has anyone thought about setting up a wiki on sourceforge for Rails?
>
> Stefan
>
> On Wednesday 10 February 2010 22:48:59 Rick Westerman wrote:
>> > Care to collaborate on such documentation? I presume the audience is
>> > developers rather than users for now.
>>
>> Yes.  Specifically for people who would want to add a new game to Rails
>> without having to do much extra coding.  In other words perhaps a game
>> based on 1830 with parts from 1835 and 1870.  Or something not too
> radical.
>>
>> > What do you like to improve?
>> >
>> >
>> > 2. Document the folder structure.
>>
>> Yes. This.  Folder structure and what files are in the structure.
>>
>> I do not see a need to change the folder structure to "best practices".
>> Rather I am willing to work with it as it is.
>>
>> > PS: Out of curiosity, I still use TextMate (a Mac editor) and ant to
>> > build stuff. However, I am also using eclipse for debugging. Do you use
>> > any debugging, and if so, using what tools?
>>
>> No debugging so far.  But then I am not doing major modifications to the
>> java code.
>>
>>
>> My time is limited as well.  I will try to upload what I do have later
>> tonight.
>
>
>
> ----------------------------------------------------------------------------
> --
> SOLARIS 10 is the OS for Data Centers - provides features such as DTrace,
> Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW
> http://p.sf.net/sfu/solaris-dev2dev
> _______________________________________________
> Rails-devel mailing list
> Rai...@li...
> https://lists.sourceforge.net/lists/listinfo/rails-devel
>
>
> ------------------------------------------------------------------------------
> SOLARIS 10 is the OS for Data Centers - provides features such as DTrace,
> Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW
> http://p.sf.net/sfu/solaris-dev2dev
> _______________________________________________
> Rails-devel mailing list
> Rai...@li...
> https://lists.sourceforge.net/lists/listinfo/rails-devel
>