6
6
(Perhaps reuse this: https://about.readthedocs.com/images/homepage.png)
7
7
8
8
9
- Building documentation on every git commit
9
+ Building documentation on every Git commit
10
10
==========================================
11
11
12
12
Read the Docs is a *Continuous Documentation Deployment * platform for your software project.
@@ -25,7 +25,7 @@ Continuous Documentation for software projects
25
25
26
26
Documentation fits into any CI/CD pipeline through the idea and objectives of *Documentation as Code *.
27
27
A straight-forward method to achieve this is by maintaining documentation alongside the source code,
28
- meaning that the documentation's life cycle is contained within the same git repository as the source code.
28
+ meaning that the documentation's life cycle is contained within the same Git repository as the source code.
29
29
30
30
When changes happen to the source code, changes should also happen to the documentation.
31
31
By managing these changes in the same life cycle,
@@ -41,7 +41,7 @@ Continuous Documentation for all projects
41
41
42
42
All categories of documentation benefit from being *continuously * built and published through Read the Docs.
43
43
44
- If you are managing your documentation in git ,
44
+ If you are managing your documentation in Git ,
45
45
you will be able to preview changes and see accepted changes published immediately using :doc: `/pull-requests `.
46
46
47
47
Automated versioning
@@ -50,10 +50,10 @@ Automated versioning
50
50
With Read the Docs' automated CI/CD pipeline, you will be able to fully align your project's **release cycle ** with your documentation.
51
51
For instance, a new version of a software project can build and publish a new version of its documentation.
52
52
53
- Read the Docs is notified of all changes to your git branches and git tags.
53
+ Read the Docs is notified of all changes to your Git branches and tags.
54
54
When you release a new version for your project,
55
- you are likely also adding a version tag to your git repository.
56
- These git events can be configured to build and publish your documentation automatically with :doc: `/automation-rules `.
55
+ you are likely also adding a version tag to your Git repository.
56
+ These Git events can be configured to build and publish your documentation automatically with :doc: `/automation-rules `.
57
57
If you use a versioning schema, you can configure it as part of the automation process.
58
58
59
59
Whether you choose to handle versioning automatically or with manual control is up to you.
0 commit comments