Add actionable TODOs for every sparse or empty section in the compile…

…r guide
vala-lang · Dec 19, 2024 · 29bc420 · 29bc420
1 parent 4da7ee5
commit 29bc420
Show file tree

Hide file tree

Showing 10 changed files with 72 additions and 5 deletions.
diff --git a/...ibutor-guide/compiler-guide/03-00-the-vala-compiler/03-03-semantic-analyzer.rst b/...ibutor-guide/compiler-guide/03-00-the-vala-compiler/03-03-semantic-analyzer.rst
@@ -16,7 +16,10 @@ Inside the process_attributes() method of each of these objects, a series of str
 
 .. todo::
 
-   fixme: mention Vala.Parser.set_attributes()
+   Mention Vala.Parser.set_attributes()
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
 
 Attributes Recognized by Vala
 

diff --git a/...ontributor-guide/compiler-guide/03-00-the-vala-compiler/03-05-flow-analyzer.rst b/...ontributor-guide/compiler-guide/03-00-the-vala-compiler/03-05-flow-analyzer.rst
@@ -1,2 +1,9 @@
 Flow Analyzer
 =============
+
+.. TODO::
+
+   Add information about flow analyzer in Vala compiler
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
diff --git a/...ibutor-guide/compiler-guide/03-00-the-vala-compiler/03-06-c-code-generation.rst b/...ibutor-guide/compiler-guide/03-00-the-vala-compiler/03-06-c-code-generation.rst
@@ -1,2 +1,9 @@
 C Code Generation
-=================
+=================
+
+.. TODO::
+
+   Add information about C Code Generation in Vala compiler
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
diff --git a/...compiler-guide/03-00-the-vala-compiler/03-07-c-code-compilation-and-linking.rst b/...compiler-guide/03-00-the-vala-compiler/03-07-c-code-compilation-and-linking.rst
@@ -1,2 +1,9 @@
 C Code Compilation and Linking
 ==============================
+
+.. TODO::
+
+   Add information about C Code Compilation and Linking in Vala compiler
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
diff --git a/source/contributor-guide/compiler-guide/05-00-internal-libgee.rst b/source/contributor-guide/compiler-guide/05-00-internal-libgee.rst
@@ -3,4 +3,7 @@ libgee Internal
 
 .. todo::
 
-   What is the difference between external and internal libgee?
+   Explain what the difference between external and internal libgee
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
diff --git a/source/contributor-guide/compiler-guide/06-00-other-tools.rst b/source/contributor-guide/compiler-guide/06-00-other-tools.rst
@@ -4,8 +4,30 @@ Other Tools
 gen-introspect
 --------------
 
+.. TODO::
+
+   Add information about the gen-introspect tool
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
+
 vapigen
 -------
 
+
+.. TODO::
+
+   Add information about the vapigen tool
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
+
 vala-gen-introspect
---------------------
+--------------------
+
+
+.. TODO::
+
+   Add information about the vala-gen-introspect tool
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
diff --git a/source/contributor-guide/compiler-guide/07-00-testing.rst b/source/contributor-guide/compiler-guide/07-00-testing.rst
@@ -4,3 +4,10 @@ Testing
 A goal for Vala 1.0 is to have every tests for every documented feature of the language.
 
 In order to run tests with ``make check`` you must have dbus-glib development files installed, otherwise you will get invalid test failures.
+
+.. TODO::
+
+   Expand on this section, explaining how the tests work in the Vala Compiler Repository.
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
diff --git a/source/contributor-guide/compiler-guide/08-00-documentation.rst b/source/contributor-guide/compiler-guide/08-00-documentation.rst
@@ -9,8 +9,14 @@ The source code for the compiler guide is in `<https://github.com/vala-lang/vala
 
    Add Generated binding documentation
 
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
+
 .. todo::
 
    Add libvala documentation
 
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
+
 `<https://github.com/vala-lang/vala-docs>`_ - The documentation repository (the source code for this website) is open to anyone who would like to make a quality contribution.
diff --git a/source/contributor-guide/compiler-guide/09-00-build-system.rst b/source/contributor-guide/compiler-guide/09-00-build-system.rst
@@ -7,6 +7,9 @@ Vala is built using the standard GNU Autotools. The built executables are actual
 
    Add Vala debug instructions.
 
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
+
+
 **./configure** uses the AC_PATH_PROG macro to choose the **valac** which is on your path, or one specified in the VALAC environment variable. Therefore, to build Vala with your own **valac**, type this, for example:
 
 .. code-block:: console

diff --git a/source/contributor-guide/index.rst b/source/contributor-guide/index.rst
@@ -45,7 +45,9 @@ Committing Patches
 
 .. todo::
 
-   TODO
+   Add information about how to commit patches to the compiler project.
+
+   Feel free to help: `Vala Docs Repository <https://github.com/vala-lang/vala-docs>`_.
 
 Maintaining Bindings
 --------------------