Skip to content

Commit 06ad908

Browse files
committed
Merge branch 'main' into nienn/product-page-template
2 parents 7532435 + 8fb3296 commit 06ad908

File tree

16 files changed

+53
-156
lines changed

16 files changed

+53
-156
lines changed

content/pages/homepage.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
title: Read the Docs
2-
subtitle: Example subtitle
1+
title:
2+
subtitle:
33
template: readthedocs/homepage
44
save_as: index.html
55
status: hidden
6-
description: Read the Docs
7-
6+
description: Read the Docs simplifies software documentation by building, versioning, and hosting of your docs, automatically. Think of it as Continuous Documentation.

examples/mockups/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848

4949
<div class="column seven wide computer nine wide tablet sixteen wide mobile">
5050
<h1 class="ui header massive">
51-
<span class="ui header">Continuous documentation for technical projects</span>
51+
<span class="ui header">Push your docs, <br>we'll do the rest</span>
5252
</h1>
5353
<div class="ui basic vertical padded huge segment">
5454
<p>
@@ -57,7 +57,7 @@ <h1 class="ui header massive">
5757
</div>
5858

5959
<div>
60-
<a href="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" class="ui button large secondary gradient fade">Start your docs</a>
60+
<a href="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" class="ui button large secondary gradient fade">Get started!</a>
6161
<a href="./product.html" class="ui button large secondary basic">Learn more</a>
6262
</div>
6363

@@ -146,23 +146,23 @@ <h2 class="ui header">How it works</h2>
146146
<img src="images/infographic-01.png">
147147
</div>
148148
<p>
149-
Write your documentation easily, using .md or .rst, directly in your own IDE, as you work on what maters: your project.
149+
Write your documentation easily, using Markdown or reStructuredText, directly in your own IDE, as you work on what matters: your project.
150150
</p>
151151
</div>
152152
<div class="column center aligned">
153153
<div class="ui image">
154154
<img src="images/infographic-02.png">
155155
</div>
156156
<p>
157-
Upload your work to your favorite source code repository hosting service. We support GitHub, GitLab, BitBucket and more.
157+
Read the Docs watches your repository and rebuilds your documentation any time you make a change.
158158
</p>
159159
</div>
160160
<div class="column center aligned">
161161
<div class="ui image">
162162
<img src="images/infographic-03.png">
163163
</div>
164164
<p>
165-
Setup your account with Read the Docs, add a .config file to tell us your preferences and we'll do the rest!
165+
Setup your account with Read the Docs, add a <code>.readthedocs.yaml</code> file to set the configuration, and we'll do the rest!
166166
</p>
167167
</div>
168168

@@ -188,11 +188,11 @@ <h2 class="ui header">How it works</h2>
188188

189189
<div class="ui basic vertical huge segment">
190190
<p>
191-
We generate, host and manage your documentation versions for you, outputting both html and pdf formats.
191+
We generate HTML, PDF, and EPUB formats for your project, and host and manage documentation versions for you.
192192
Whenever you push code, we'll build your docs.
193193
</p>
194194
<p>
195-
<big>It Just works.</big>
195+
<big>Get your docs online in 5 minutes.</big>
196196
</p>
197197
</div>
198198

examples/mockups/product.html

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,43 +59,29 @@ <h1 class="ui header massive"><<i>missing</i>> Infographic</h1>
5959
<h3 class="ui header inverted"><<i>missing</i>> Illustration</h3>
6060
<h3 class="ui header inverted">Docs as Code</h3>
6161
<p>
62-
Read the Docs simplifies the entire process of building and deploying developer documentation. With support for Sphinx and Mkdocs, you can integrate your code and user-facing documentation using the same tools. Create beautiful documentation easily with themes, and preview every commit with Pull Request previews.
62+
Read the Docs simplifies the entire process of building and deploying developer documentation. With support for Sphinx, Mkdocs, and Jupyter Book, you can integrate your code and user-facing documentation using the same tools. Create beautiful documentation easily with themes, and preview every commit with pull request previews.
6363
</p>
6464

6565
<div class="ui list inverted relaxed divided">
66-
67-
<div class="item">
68-
<i class="icon check circle green"></i>
69-
<div class="content">
70-
<div class="description">Issue Tracking</div>
71-
</div>
72-
</div>
73-
74-
<div class="item">
75-
<i class="icon check circle green"></i>
76-
<div class="content">
77-
<div class="description">Version Control</div>
78-
</div>
79-
</div>
8066

8167
<div class="item">
8268
<i class="icon check circle green"></i>
8369
<div class="content">
84-
<div class="description">Plain Text Markup</div>
70+
<div class="description">Write your docs in plain text for easy review and translation</div>
8571
</div>
8672
</div>
87-
73+
8874
<div class="item">
8975
<i class="icon check circle green"></i>
9076
<div class="content">
91-
<div class="description">Code Reviews</div>
77+
<div class="description">Preview documentation changes before they are merged</div>
9278
</div>
9379
</div>
9480

9581
<div class="item">
9682
<i class="icon check circle green"></i>
9783
<div class="content">
98-
<div class="description">Automated Tests</div>
84+
<div class="description">Receive a Slack notification if your documentation build fails</div>
9985
</div>
10086
</div>
10187

@@ -121,7 +107,14 @@ <h3 class="ui header inverted">Write with reStructuredText or Markdown</h3>
121107
<div class="item">
122108
<i class="icon check circle green"></i>
123109
<div class="content">
124-
<div class="description">Documentation culture empowerment</div>
110+
<div class="description">Empower your developers to write docs</div>
111+
</div>
112+
</div>
113+
114+
<div class="item">
115+
<i class="icon check circle green"></i>
116+
<div class="content">
117+
<div class="description">Include internal and external cross references</div>
125118
</div>
126119
</div>
127120

@@ -160,7 +153,7 @@ <h3 class="ui header inverted">Easy Documentation Deployment for Technical Teams
160153
<div class="item">
161154
<i class="icon check circle green"></i>
162155
<div class="content">
163-
<div class="description">Multiple Versions</div>
156+
<div class="description">Multiple versions</div>
164157
</div>
165158
</div>
166159

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"main": "src/js/index.js",
66
"scripts": {
77
"clean": "npm run clean-assets && npm run clean-html",
8-
"clean-assets": "rm -rfv readthedocs-theme/static/*; exit 0",
8+
"clean-assets": "rm -rfv readthedocs-theme/static/{css,js}; exit 0",
99
"clean-html": "rm -rfv output/*; exit 0",
1010
"build": "npm run build-assets && npm run build-html",
1111
"build-assets": "npm run clean-assets && webpack --mode=production --progress --colors",
5.73 KB
Loading
5.61 KB
Loading
2.99 KB
Loading
4.33 KB
Loading
10.2 KB
Loading
2.11 KB
Loading

0 commit comments

Comments
 (0)