web/documentation

   1 * Documentation
   2
   3         Although most of the concepts from Microsoft.NET can
   4         be applied to the completed Mono platform, we do need to
   5         have a complete set of free documentation written specifically
   6         for Mono.
   7
   8         The documentation license we have chosen is the GNU Free
   9         Documentation License (FDL), the standard for most documents
  10         in the free software world.
  11
  12         We need documentation on a number of topics:
  13
  14         <ul>
  15
  16                 * The development tools (compilers, assembler tools,
  17                   language reference, design time features).
  18
  19                 * Frequently Asked Question compilations.
  20
  21                 * HOWTO documents.
  22
  23                 * The Class Libraries
  24
  25                 * Tutorials on Mono and the specifics of running it.
  26
  27                 * A guide to Mono as compared to the Microsoft.NET
  28                   Framework SDK
  29
  30         </ul>
  31
  32 ** Class Library documentation
  33
  34         When contributing to the Class Library effort, please use the
  35         inline XML documentation tags to document your classes so we
  36         can automatically generate the documentation from the class
  37         libraries.
  38
  39         If you provide examples, please do not embed them into the
  40         source code, as that will make the source code harder to read
  41         and maintain.  Instead, put examples for your code into a
  42         subdirectory of the class libraries. Make your sample
  43         code a full standalone application that people can compile.
  44         Ideally the Mono documentation browser will let you edit, modify
  45         and run the sample programs.
  46
  47
  48
  49
  50