[librsvg: 3/21] Outline the developer's documentation




commit f37e3fe319a7f0dd787748c017ff9f0e9907b1df
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Jun 14 11:29:57 2022 -0500

    Outline the developer's documentation
    
    Part-of: <https://gitlab.gnome.org/GNOME/librsvg/-/merge_requests/729>

 devel-docs/index.rst | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
---
diff --git a/devel-docs/index.rst b/devel-docs/index.rst
index e22ea6800..68b6b1add 100644
--- a/devel-docs/index.rst
+++ b/devel-docs/index.rst
@@ -14,10 +14,40 @@ design document modeled on the following ones, and submit a merge
 request.  We can then discuss it before coding.  This way we will have
 a sort of big-picture development history apart from commit messages.
 
+Getting started
+===============
+
+FIXME: link to doc with stuff from CONTRIBUTING.md's "Hacking on librsvg"
+
+Add basic info on cloning the repo, getting a gitlab account, forking.
+
+Development roadmap.
+
+Understand the code
+===================
+
+FIXME: Overview of the source tree.
+
+Tour of the code - load a file, render it.
+
+Information for maintainers
+===========================
+
+FIXME: Move RELEASING.md here
+
+Overview of the maintainer's workflow.
+
+Documentation on the CI.
+
 Design documents
 ================
 
+FIXME: link the md here.
+
+Bibliography
+============
 
+Link to SVG/CSS specs; other useful bits.
 
 Indices and tables
 ==================


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]