doc-page

doc-page

[Florian Schmidt]

Hi Patrick. I saw your changes to the doc page and have one or two
remarks:

1.] The layout is a litle bit messed up here. The black line goes
through "Supported Soundcards" and "Userspace Tools". If i use a smaller
font, it's ok. so i don't know, if it's a mozilla thing [Mozilla Debian
Package 1.5-3]..

2.] There's quite a lot of info in the wiki allready and i wonder if we
could just create [initially empty] entries in the wiki for the missing
links [like dmix/dsnoop, 5.1 sound...]. There's already a dmix page in
the wiki which we could link to. As it grows more mature it can  someday
maybe be integrated into the "normal" documentation..

Using the wiki for drafts for these pages also has the advantage of that
it is very easy to set up initial pages which then can be improved.
Let's say: it becomes much easier for the user to contribute
documentation this way.. Also users who don't know what a wiki is will
soon learn if links from the doc pages go to it :)

3.] Contrary to my first draft of the TOC i would suggest moving the
soundcard matrix to the system maintainers section. Also the name "Sound
Card Matrix & User documentation" is misleading. I suppose this means
the user supplied info regarding each driver. I would rather have "User
documentation" as a single Topic for documentation that is really aimed
at the end user [This contains the userspace tools and the .asoundrc,
though this also overlaps with system maintainers stuff]

Flo

P.S.: If you want help with it, i could just do the changes to a local
copy and then send you a diff.

-- 
music: http://www.soundclick.com/bands/9/florianschmidt.htm




-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/

Re: doc-page

[Patrick Shirkey]

Florian Schmidt wrote:
> Hi Patrick. I saw your changes to the doc page and have one or two
> remarks:
> 
> 1.] The layout is a litle bit messed up here. The black line goes
> through "Supported Soundcards" and "Userspace Tools". If i use a smaller
> font, it's ok. so i don't know, if it's a mozilla thing [Mozilla Debian
> Package 1.5-3]..
> 

Yeah I removed it (was just playing around with layout).

> 2.] There's quite a lot of info in the wiki allready and i wonder if we
> could just create [initially empty] entries in the wiki for the missing
> links [like dmix/dsnoop, 5.1 sound...]. There's already a dmix page in
> the wiki which we could link to. As it grows more mature it can  someday
> maybe be integrated into the "normal" documentation..
> 
> Using the wiki for drafts for these pages also has the advantage of that
> it is very easy to set up initial pages which then can be improved.
> Let's say: it becomes much easier for the user to contribute
> documentation this way.. Also users who don't know what a wiki is will
> soon learn if links from the doc pages go to it :)
> 

I would prefer to have actual data before we make a link. It drives me 
nuts when I go to find info on the official site for a project and the 
links just lead to dead ends. The extra clicks for nothing make me feel 
annoyed.

> 3.] Contrary to my first draft of the TOC i would suggest moving the
> soundcard matrix to the system maintainers section. Also the name "Sound
> Card Matrix & User documentation" is misleading. I suppose this means
> the user supplied info regarding each driver. I would rather have "User
> documentation" as a single Topic for documentation that is really aimed
> at the end user [This contains the userspace tools and the .asoundrc,
> though this also overlaps with system maintainers stuff]
> 

People have given a lot of suggestions for the matrix which I'm working 
on adding. I'm trying to find a way to combine all these things into a 
neat little package. Until then we will just have to make do with links 
to all the various sources as our main stay.

> 
> P.S.: If you want help with it, i could just do the changes to a local
> copy and then send you a diff.
> 

Sure. Any contributions are welcome.


-- 
Patrick Shirkey - Boost Hardware Ltd.
Http://www.boosthardware.com
Http://www.djcj.org - The Linux Audio Users guide
========================================


  Apparently upon the beginning of the barrage, the donkey broke 
discipline and panicked, toppling the cart. At that point, the rockets 
disconnected from the timer, leaving them strewn around the street. 
Tethered to the now toppled cart, the donkey was unable to escape before 
the arrival of U.S. troops.

United Press International
Rockets on donkeys hit major Baghdad sites

By P. MITCHELL PROTHERO
Published 11/21/2003 11:13 AM



-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/

Re: Re: doc-page

[Martin Langer]

Thank you very much, Patrick for the work you've done until now.

But one point I still miss is some kind of browseable Changelog. And a good
complete changelog history is also good for detecting bugs.

Well, only the users in the mailling lists can know if driver xy has changed
(or maybe improved) since the last version or not. So normal users have to
try out each version. And that's far away from perfect IMHO.


just my two cents.

martin


-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/

Re: Re: doc-page

[Patrick Shirkey]

Martin Langer wrote:
> Thank you very much, Patrick for the work you've done until now.
> 
> But one point I still miss is some kind of browseable Changelog. And a good
> complete changelog history is also good for detecting bugs.
> 
> Well, only the users in the mailling lists can know if driver xy has changed
> (or maybe improved) since the last version or not. So normal users have to
> try out each version. And that's far away from perfect IMHO.
> 

Nice idea. I think I know how this can be accomplished too.

I'll look into it.


-- 
Patrick Shirkey - Boost Hardware Ltd.
Http://www.boosthardware.com
Http://www.djcj.org - The Linux Audio Users guide
========================================


  Apparently upon the beginning of the barrage, the donkey broke 
discipline and panicked, toppling the cart. At that point, the rockets 
disconnected from the timer, leaving them strewn around the street. 
Tethered to the now toppled cart, the donkey was unable to escape before 
the arrival of U.S. troops.

United Press International
Rockets on donkeys hit major Baghdad sites

By P. MITCHELL PROTHERO
Published 11/21/2003 11:13 AM



-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/