@@ -4,19 +4,22 @@ CrateDB Documentation System
44
55|version | |ci | |rtd |
66
7- Build system, authoring and QA tools, and a style guide for the
7+ Build system, authoring, and QA tools, and a style guide for the
88`CrateDB documentation `_.
99
1010
1111🧐 What's Inside
1212================
1313
14- This section gives you an overview about what's inside the relevant
15- folders .
14+ - ** docs ** contains an example documentation instance for demonstration
15+ purposes .
1616
17- - **docs ** contains an example documentation instance for demonstration purposes .
17+ - **style ** contains the CrateDB style guide .
1818
19- - **tools ** includes the `github-projects.txt `_ and `sphinx-inventories.txt `_
19+ - The **tasks.py ** file includes tooling to support operations
20+ in tech writing.
21+
22+ - The **registry ** folder includes the `github-projects.txt `_ and `sphinx-inventories.txt `_
2023 files, which enumerate all repositories and target URLs that resemble
2124 the documentation at https://cratedb.com/docs/.
2225
@@ -45,7 +48,7 @@ There is also tooling to support `Technical Writing on HubSpot`_.
4548🔗 Intersphinx
4649--------------
4750
48- For displaying a list of intersphinx _ link targets per project ,
51+ For displaying intersphinx _ inventories to learn about available link targets ,
4952run commands like this::
5053
5154 invoke inv https://cratedb.com/docs/crate/reference/en/latest/objects.inv
@@ -88,9 +91,9 @@ Looking for more help?
8891.. _Crate.io : https://cratedb.com/
8992.. _CrateDB documentation : https://cratedb.com/docs/
9093.. _developer docs : DEVELOP.rst
91- .. _github-projects.txt : tools /github-projects.txt
94+ .. _github-projects.txt : registry /github-projects.txt
9295.. _intersphinx : https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
9396.. _Sphinx : http://www.sphinx-doc.org/en/stable/
94- .. _sphinx-inventories.txt : tools /sphinx-inventories.txt
97+ .. _sphinx-inventories.txt : registry /sphinx-inventories.txt
9598.. _support channels : https://cratedb.com/support/
9699.. _Technical Writing on HubSpot : https://github.com/crate-workbench/hubspot-tech-writing
0 commit comments