ASP.Net MVC - MvcContrib - We need your opinion!

[Eric Hexter]

I started working with sandcastle to generate api documentation for the MvcContrib project.  I wanted to get some feedback from people on this list as to how useful the general API Namespace/Class listings are. Below are two of the outputs of the documentation. I encourage you to take a quick look at it so that you can provide feedback.

 

 

Here is an html versions that the project could host online.

http://mvccontrib.googlecode.com/svn/trunk/Documentation/Help/Index.html

 

Here is a CHM help file.  To view this you will need to Save As, than goto the file properties and click Unblock.  If you do not unblock the file you will see the navigation tree, but all of the content will display a page not found error.

http://mvccontrib.googlecode.com/svn/trunk/Documentation/Help/MvcContrib-Api-Documentation.chm

 

 

Questions I need feedback on:

1. Does having the Namespaces and classes browsable in this format provide and value as a user of the mvccontrib project? 
2. If all of the feature documentation from the CodePlex wiki was included in the help file would that make a difference to the value that this documentation provides? (The wiki docs are located here: http://www.codeplex.com/MVCContrib/Wiki/View.aspx?title=Documentation&referringTitle=Home)
3. Is there a better way to provide general api documentation, do you have some examples of something you like?

 

Thanks,

Eric

 

 

[Tuna Toksöz]

Firefox doesn't show the first one. It shows its as plain text.

--
Tuna Toksöz

Typos included to enhance the reader's attention ...

[Eric Hexter]

Why am I not surprised that it does not work in FireFox ..... :(.   I will look through for a different html template that is browser agnostic.

[Tuna Toksöz]

I think this has something to do with IE. Since it is svn, I "believe" the content type is sent as plain text but ie wants to render it as html.

I personally don't like CHM files and i believe rather than having api documentation, it would be more useful to have some general documentation such as the one castle has.
http://www.castleproject.org/monorail/documentation/trunk/usersguide/viewcomponents.html

Something like this

On Sun, Mar 30, 2008 at 2:26 PM, Eric Hexter <eric....@gmail.com> wrote:

Why am I not surprised that it does not work in FireFox ..... :(.   I will look through for a different html template that is browser agnostic.

[Simone Busoli]

I don't like chms a lot either. What I'd like to have instead is a searchable html, like Ruby's.