Project - Documentation: Difference between revisions

Revision as of 17:14, 17 April 2020

This article is deals with projects related to improving GNU Octave's documentation. For general project ideas, see Projects.

For a comprehensive list see Publications about Octave.

Improve the Texinfo Documentation for the interpreter. It would be useful to have lots more examples, to not have so many forward references, and to not have very many simple lists of functions.

@@ Line 1: / Line 1: @@
 :''This article is deals with projects related to improving GNU Octave's documentation.  For general project ideas, see [[Projects]].''
-*Improve the Texinfo Documentation for the interpreter. It would be useful to have lots more examples, to not have so many forward references, and to not have very many simple lists of functions.
+== Existing Documentation ==
+:''For a comprehensive list see [[Publications about Octave]].''
+* [[Doxygen]] documentation for the C++ classes.
-*[[Doxygen]] documentation for the C++ classes.
+* [https://www.gnu.org/software/texinfo/ Texinfo] documentation for the [https://octave.org/doc/interpreter/ Octave interpreter].
-*Make index entries more consistent to improve behavior of <code>help -i</code>.
+* This wiki:
+** [[FAQ]]
+** [[:Category:Resources | Resources: Tutorials, Examples, Tips and Tricks, ...]]
-*Make <code>help -i</code> try to find a whole word match first.
+== Projects ==
+*Improve the Texinfo Documentation for the interpreter. It would be useful to have lots more examples, to not have so many forward references, and to not have very many simple lists of functions.
 *Add more demo files.
+*Add more Doxygen comments.
 *Flesh out this wiki
 [[Category:Project Ideas]]