Project - Documentation: Difference between revisions
Jump to navigation
Jump to search
(→News: Add contact information.) |
(→Projects: First draft for suggested projects.) |
||
| Line 19: | Line 19: | ||
** [[:Category:Resources | Resources: Tutorials, Examples, Tips and Tricks, ...]] | ** [[:Category:Resources | Resources: Tutorials, Examples, Tips and Tricks, ...]] | ||
== Projects == | == Suggested Projects == | ||
=== Octave's interpreter documentation === | |||
The documentation for the interpreter is presumably the oldest, long grown documentation of the GNU Octave project. 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. | |||
*Flesh out this wiki | * '''Source code''' | ||
: https://hg.savannah.gnu.org/hgweb/octave/file/tip/doc/interpreter | |||
* '''Required skills''' | |||
: [https://www.gnu.org/software/texinfo/ Texinfo], [https://www.mercurial-scm.org/ hg], [[Building | building Octave from source]] | |||
* '''Potential mentors''' | |||
: [[User:siko1056 | Kai]] | |||
=== Octave's internal documentation === | |||
Add more Doxygen comments. | |||
=== Octave's wiki === | |||
Flesh out this wiki. | |||
[[Category:Project Ideas]] | [[Category:Project Ideas]] | ||
Revision as of 17:59, 17 April 2020
- This article is deals with projects related to improving GNU Octave's documentation. For general project ideas, see Projects.
News
- GNU Octave applies for the Google Season of Docs (GSoD) 2020. Potential participation will be announced on May 11, 2020 at 12:00 UTC. Discuss about your ideas and application with us by using Octave's
maintainers@octave.orgmailing list (please bottom post!)#octaveIRC channel in Freenode
Existing Documentation
- For a comprehensive list see Publications about Octave.
- Doxygen documentation for the C++ classes.
- Texinfo documentation for the Octave interpreter.
Suggested Projects
Octave's interpreter documentation
The documentation for the interpreter is presumably the oldest, long grown documentation of the GNU Octave project. 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.
- Source code
- Required skills
- Potential mentors
Octave's internal documentation
Add more Doxygen comments.
Octave's wiki
Flesh out this wiki.