From 619e31a8c3c04e445c78140ec9db323e05fec66d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Kochma=C5=84ski?= Date: Wed, 2 Mar 2016 14:45:36 +0100 Subject: [PATCH] new-doc: add preliminary contributing guide Mostly empty now --- .../new-doc/developer-guide/contributing.txi | 40 +++++++++++++++++++ src/doc/new-doc/developer-guide/index.txi | 3 +- 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 src/doc/new-doc/developer-guide/contributing.txi diff --git a/src/doc/new-doc/developer-guide/contributing.txi b/src/doc/new-doc/developer-guide/contributing.txi new file mode 100644 index 000000000..50db5118b --- /dev/null +++ b/src/doc/new-doc/developer-guide/contributing.txi @@ -0,0 +1,40 @@ +@node Contributing +@section Contributing + +@menu +* Documentation:: Documentation conventions +@end menu + +@node Documentation +@subsection Documentation + +How to define functions: + +@verbatim +@[sub*]heading @code{ext:run-program} – Short description +@lspindex ext:run-program +@defun ext:run-program ... + +@table @var +@item arg-1 +description +@item arg-2 +description +@item returns +One value? More? +@end table + +@strong{Description} +Description here + +@strong{Examples} + +Example one +@exindex @code{ext:run-program} sample run +@lisp +(ext:run-program "ls") +@end lisp + +@end defun + +@end verbatim diff --git a/src/doc/new-doc/developer-guide/index.txi b/src/doc/new-doc/developer-guide/index.txi index eeb317cf7..1c0671bf4 100644 --- a/src/doc/new-doc/developer-guide/index.txi +++ b/src/doc/new-doc/developer-guide/index.txi @@ -3,7 +3,7 @@ @menu @c * Sources structure:: Overview of the source code structure -@c * Contributing:: Code, documentation and tests standards +* Contributing:: Code, documentation and tests standards @c * Modules hierarchy:: @c * Testing and benchmarking:: * Manipulating Lisp objects:: @@ -15,5 +15,6 @@ @c * Current roadmap:: @end menu +@include developer-guide/contributing.txi @include developer-guide/objects.txi @include developer-guide/environment.txi