From cc2576cec1a83220ade80b3c5ea6d47ba580895b Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Tue, 24 Jan 2023 09:52:54 -0600 Subject: devel-docs: Remove the "in librsvg", "for librsvg", etc. suffixes They seemed to make more sense when we had scattered documents, but now they are redundant in the table of contents. --- devel-docs/adding_a_property.rst | 4 ++-- devel-docs/architecture.rst | 4 ++-- devel-docs/ci.rst | 6 ++++-- devel-docs/contributing.rst | 4 ++-- devel-docs/features.rst | 4 ++-- devel-docs/index.rst | 2 +- devel-docs/memory_leaks.rst | 4 ++-- devel-docs/releasing.rst | 4 ++-- devel-docs/text_layout.rst | 4 ++-- 9 files changed, 19 insertions(+), 17 deletions(-) diff --git a/devel-docs/adding_a_property.rst b/devel-docs/adding_a_property.rst index b8ade985..fe2aca07 100644 --- a/devel-docs/adding_a_property.rst +++ b/devel-docs/adding_a_property.rst @@ -1,5 +1,5 @@ -Adding a new CSS property to librsvg -==================================== +How to add a new CSS property +============================= This document is a little tour on how to add support for a CSS property to librsvg. We will implement the ```mask-type`` diff --git a/devel-docs/architecture.rst b/devel-docs/architecture.rst index c8b7d4e1..a73a65f4 100644 --- a/devel-docs/architecture.rst +++ b/devel-docs/architecture.rst @@ -1,5 +1,5 @@ -Architecture of librsvg -======================= +Architecture +============ This document roughly describes the architecture of librsvg, and future plans for it. The code is continually evolving, so don’t consider this diff --git a/devel-docs/ci.rst b/devel-docs/ci.rst index f75b9216..31d212e4 100644 --- a/devel-docs/ci.rst +++ b/devel-docs/ci.rst @@ -1,5 +1,7 @@ -Continuous Integration - When robots are eager to help -====================================================== +Continuous Integration +====================== + +Or, when robots are eager to help. Librsvg's repository on gitlab.gnome.org is configured to use a Continuous Integration (CI) pipeline, so that it compiles the code and diff --git a/devel-docs/contributing.rst b/devel-docs/contributing.rst index 5bfbd6c4..57ed6ef8 100644 --- a/devel-docs/contributing.rst +++ b/devel-docs/contributing.rst @@ -1,5 +1,5 @@ -Contributing to librsvg -======================= +How to contribute +================= Thank you for looking in this document! There are different ways of contributing to librsvg, and we appreciate all of them. diff --git a/devel-docs/features.rst b/devel-docs/features.rst index d21cd07d..d975d01f 100644 --- a/devel-docs/features.rst +++ b/devel-docs/features.rst @@ -1,5 +1,5 @@ -SVG and CSS features that librsvg supports -========================================== +Supported SVG and CSS features +============================== Librsvg tries to be a mostly complete renderer for `SVG1.1 `_ and `SVG2 diff --git a/devel-docs/index.rst b/devel-docs/index.rst index 097fb514..455e123b 100644 --- a/devel-docs/index.rst +++ b/devel-docs/index.rst @@ -41,7 +41,7 @@ Development guide for librsvg :maxdepth: 1 releasing - Continuous Integration + ci Welcome to the developer's guide for librsvg. This is for people who want to work on the development of librsvg itself, not for users of diff --git a/devel-docs/memory_leaks.rst b/devel-docs/memory_leaks.rst index 5e186a19..5f4aa811 100644 --- a/devel-docs/memory_leaks.rst +++ b/devel-docs/memory_leaks.rst @@ -1,5 +1,5 @@ -Memory leaks in librsvg -======================= +Apparent memory leaks +===================== If you run Valgrind or another memory checker on a program that uses librsvg, or ``rsvg-convert``, you may get false positives. This chapter explains why these occur by diff --git a/devel-docs/releasing.rst b/devel-docs/releasing.rst index 2f0df11e..d168a7c0 100644 --- a/devel-docs/releasing.rst +++ b/devel-docs/releasing.rst @@ -1,5 +1,5 @@ -Release process checklist for librsvg -===================================== +Release process checklist +========================= Feel free to print this document or copy it to a text editor to check off items while making a release. diff --git a/devel-docs/text_layout.rst b/devel-docs/text_layout.rst index 982d15e5..cc485cac 100644 --- a/devel-docs/text_layout.rst +++ b/devel-docs/text_layout.rst @@ -1,5 +1,5 @@ -Text layout in librsvg -====================== +Text layout +=========== This document describes the state of text layout in librsvg as of version 2.55.90, and how I want to overhaul it completely for SVG2. -- cgit v1.2.1 From 50b381bb7518405314198f52e9a5c111241bcc8e Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Tue, 24 Jan 2023 09:59:03 -0600 Subject: Add missing link --- devel-docs/index.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/devel-docs/index.rst b/devel-docs/index.rst index 455e123b..8f21dad9 100644 --- a/devel-docs/index.rst +++ b/devel-docs/index.rst @@ -71,10 +71,7 @@ Getting started --------------- - :doc:`devel_environment` - -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. +- :doc:`contributing` Understand the code ------------------- -- cgit v1.2.1