Re: [Hamlib-developer] Documentation plan

[Frank S. <vk...@ix...>]

Nate Bargmann wrote:
> 
> Okay, I've been going over things the past day or so and would like to
> get started by creating an introductory homepage for hamlib.  Some
> things I'd like to include are an overview of the library's purpose and
> its implementation. 

Yes, lets tell people what its about, its goals, status, ambition,
world domination  ... :)

Our empty web space is not that eye-catching !!

A little diagram showing frontend API and the backends
would also help visualisation of the project.

Also some site navigation, status, FAQ, "latest news" areas 
etc would be good.

> After that is in place I'd like to expand that by
> documenting the version 1.1.0 API.  As this becomes complete it should
> probably be included in the next stable release.  Far into the future
> come things like HOWTO guides and radio command indexes and such.
> 

The frontend API has some markups to assist documentation.
Stephane, comments. Also the rig capabilities matrix would
be nice... :)

> Is there a preferred style for the web pages?  I don't plan on using
> frames or a lot of fancy gizmos.

Good, there are still a lot of us with low bandwidth 
connections (sigh..). Mostly I am not a frames fan,
although they occasionally provide some navigational 
use. I could live without them :^)

> 
> Finally, I installed the ssh (OpenSSH) 1.2.3-9.1 debian package
> yesterday, but cannot log into hamlib.sourceforge.net as the Sourceforge
> documentation indicates.  Is this reserved for the project owner, or is
> there some other reason (Frank?).  Or will I need to contact Sourceforge
> to get this resolved?
> 

Hmm, let me check, I just uploaded my pub ssh key and waited 24
hours, from memory...

I know there have been some problems with the sourceforge 
re-shuffle. eg: Our CVS commits are normally emailed our cvs-devel
list, but that stopped recently. I have a ticket open on it.


Welcome onboard Nate.

Cheers / Frank 

73's de vk3fcs & km5ws