Web site - doc project

Hello,

Congratulations for the new great website look !

Talking about the website, I have a very small and unimportant suggestion :

Why is there a link in the “Documentation” section that is called “Doc
Project” ? It’s the first time I see a place where a "Documentation project"
is PART of the whole documentation stuff. Shouldn’t it be called “SDL API
Reference”, and the whole section of the website menu “Documentation
project” (or better, just plain “Documentation”) ?

Practically speaking, I have to browse the website menu each time searching
for the word “Reference” or “API” or “Complete reference” as it uses to be
for other libraries, and it takes some time before I try “Document project”,
because it sounds more like it would be a webpage where people that write
SDL documentation exchange points of views or stuff like that…

My 2 cents,

Dom–
Dominic Genest
?tudiant 3e cycle
D?partement d’Informatique et de G?nie Logiciel
Universit? Laval
97010111

Dominic Genest wrote:

Why is there a link in the “Documentation” section that is called “Doc
Project” ? It’s the first time I see a place where a "Documentation project"
is PART of the whole documentation stuff. Shouldn’t it be called “SDL API
Reference”, and the whole section of the website menu “Documentation
project” (or better, just plain “Documentation”) ?

btw: Is there ongoing work on the api reference/doc project ?

Ciao–
Marco
-------------- next part --------------
A non-text attachment was scrubbed…
Name: not available
Type: application/pgp-signature
Size: 481 bytes
Desc: Digital signature
URL: http://lists.libsdl.org/pipermail/sdl-libsdl.org/attachments/20040225/83fcb454/attachment.pgp

i think not.
the current doc project seems to be on hold
there’s a sdl doc wiki out there but i think it’s rather incomplete.

someone should take the wiki, update it with the old doc project stuff
and integrate it into the sdl page.
i could integrate the old doc project into the wiki and it shouldn’t be
too hard integrating that in the main sdl page (i think this is about
half an hour of work).

but i tink there’s someone else currently working on that, but haven’t
heard about any progress yet.

Marco Kraus wrote:>Dominic Genest wrote:

Why is there a link in the “Documentation” section that is called “Doc
Project” ? It’s the first time I see a place where a "Documentation project"
is PART of the whole documentation stuff. Shouldn’t it be called “SDL API
Reference”, and the whole section of the website menu “Documentation
project” (or better, just plain “Documentation”) ?

btw: Is there ongoing work on the api reference/doc project ?

Ciao

Florian Hufsky wrote:

someone should take the wiki, update it with the old doc project stuff
and integrate it into the sdl page.
i could integrate the old doc project into the wiki and it shouldn’t be
too hard integrating that in the main sdl page (i think this is about
half an hour of work).

but i tink there’s someone else currently working on that, but haven’t
heard about any progress yet.

It would be nice to have an up-to-date API reference, some more examples,
different doc-formats (pdf is one of the most asked), etc.

Who’s doing the current work ? Is any help needed ? How is the current
work organized ?

Maybe someone knows the answer :wink:

Ciao–
Marco

  • Die Revolution sagt: ich war, ich bin, ich werde sein -