Re: gEDA-dev: What should be included in the dist file?

[Svenn Are Bjerkem <svenn-at-NOSPAMbjerkem_dot_de>]

On Thursday 17 August 2006 06:35, David Hart wrote:
> OK. I'm probably going to ruffle a few feathers, and start a flame-war,
> but here is a much different option. Don't include the documentation
> with the distribution.

If the documentation is lagging the released version that makes sense, 
otherwise it makes sense to make documentation available through a menu item 
if the program is GUI based, or through the --help command line option. The 
user should not need to search the file system to find that pdf, because it 
should be a pdf with as much searchable text as possible. HTML is useless 
unless you release it as a chm.

>
> The reason. The gEDA wiki holds the repository for the latest
> documentation. If a user wants the latest documentation, the user should
> be encouraged to get that documentation from the gEDA wiki. If a
> developer (or heavens forbid a user) wants to update the documentation,
> they can simply modify the content in the wiki.

You make it sound simple because it is technically simple, but there is a huge 
reluctancy among most users to start fiddling with things on a wiki. Most 
wikis are still too cumbersome to keep a complete overview over. 

>
> Document authors should be aware that they can, after logging into the
> wiki, subscribe to changes made on any particular page (e.g., a
> wiki-page they authored). In this manner, document authors may follow
> changes made by others (an e-mail is sent by the wiki-engine when page
> changes are made).

I think some parts of the documentation will be very out of date because it 
will be forgotten unless you have a wiki that can enforce a particular 
sequence of reading. 

-- 
Svenn


_______________________________________________
geda-dev mailing list
geda-dev@moria.seul.org
http://www.seul.org/cgi-bin/mailman/listinfo/geda-dev