Skip to content

Commit b67eccd

Browse files
humitoshumitos
committed
Landing: day to day usage
Example of "How to use Read the Docs in your daily work" after reading the onboarding book on Book Club. The idea of this page is to show _exactly_ how customers will use Read the Docs on their day to day work to make them reach that "aha" moment when they realize this workflow is a lot easier than the one they are currently following. Goals: - explain how they will use Read the Docs daily - mention docs as code workflow - explain write, push, review and deploy stages - show images representing those exact stages - mention we don't provide an editor Page based on https://about.readthedocs.com/docs-as-code/ structure.
1 parent 652947d commit b67eccd

File tree

6 files changed

+263
-4
lines changed

6 files changed

+263
-4
lines changed

‎content/images/usage/code-editor-light.png‎

115 KB
Loading

‎content/images/usage/code-editor.png‎

131 KB
Loading

‎content/images/usage/documentation.png‎

127 KB
Loading

‎content/images/usage/pull-request-collaboration.png‎

225 KB
Loading

‎content/includes/try-it-out.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ <h2 class="ui huge center aligned header">
2020
```yaml
2121
version: 2
2222
build:
23-
os: ubuntu-22.04
23+
os: ubuntu-24.04
2424
tools:
25-
python: "3.10"
25+
python: "3.12"
2626
# You can also specify other tool versions:
27-
# nodejs: "16"
27+
# nodejs: "20"
2828

2929
# Build documentation in the docs/ directory with Sphinx
3030
sphinx:
@@ -96,4 +96,4 @@ <h2 class="ui huge center aligned header">
9696

9797
</div>
9898
</div>
99-
</section>
99+
</section>

‎content/pages/usage.html‎

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
{#
2+
The goal of this page is to explain in a simple way how users will use Read the Docs in their lives.
3+
#}
4+
<html>
5+
<head>
6+
<title>Using Read the Docs daily</title>
7+
<meta name="template" content="page" />
8+
<meta name="slug" content="usage" />
9+
<meta name="status" content="hidden" />
10+
<meta name="description" content="How to use Read the Docs in your daily basis to write, build and host your documentation." />
11+
</head>
12+
<body>
13+
14+
{#
15+
View this page at http://localhost:8080/usage/index.html
16+
#}
17+
18+
{% import "partials/basic.html" as basic %}
19+
{% import "partials/features.html" as about %}
20+
{% import "partials/marketing.html" as marketing %}
21+
{% import "partials/technical.html" as technical %}
22+
{% import "partials/homepage.html" as homepage %}
23+
24+
<section>
25+
<div class="ui horizontally very padded container">
26+
<div class="ui very padded centered grid">
27+
<div class="middle aligned row">
28+
29+
<div class="ten wide computer sixteen wide tablet sixteen wide mobile column">
30+
<div class="ui large left aligned basic vertical segment">
31+
<h1 class="ui huge header">
32+
Read the Docs in your daily work
33+
</h1>
34+
35+
<p>
36+
Read the Docs helps you with building, reviewing and publishing documentation for your customers.
37+
Follow the <em>docs as code</em> pattern that you are already using.
38+
Allow your readers to browse your documentation with shiny themes and perform searches accross all your projects.
39+
They will really appreciate you are using Read the Docs for your documentation.
40+
</p>
41+
42+
{# This should be a list of benefits, not features, since we have a feature listing in the side nav #}
43+
<div class="ui list">
44+
<div class="item"><i class="fad fa-check secondary icon"></i>Write documentation using a rich ecosystem of tools (MkDocs, Docusaurus, etc).</div>
45+
<div class="item"><i class="fad fa-check secondary icon"></i>Version your documents with Git.</div>
46+
<div class="item"><i class="fad fa-check secondary icon"></i>Preview each change before publishing.</div>
47+
<div class="item"><i class="fad fa-check secondary icon"></i>Easily deploy docs on merge.</div>
48+
</div>
49+
50+
<p>
51+
Read the Docs is the <em>all-in-one</em> solution for docs as code.
52+
</p>
53+
54+
</div>
55+
</div>
56+
57+
<div class="six wide computer twelve wide tablet sixteen wide mobile column">
58+
<div class="ui padded basic segment">
59+
<div class="ui relaxed list">
60+
61+
{%- set header_1 = "Write the documentation" %}
62+
{%- set slug_1 = "write" %}
63+
{%- set icon_1 = "fa-pencil" -%}
64+
<a href="#{{ slug_1 }}" class="ui small teal header item">
65+
<i class="fad {{ icon_1 }} secondary big icon"></i>
66+
<span class="content">
67+
{{ header_1 }}
68+
<span class="sub header">Write the documentation using your favourite editor.</span>
69+
</span>
70+
</a>
71+
72+
{%- set header_2 = "Push the changes to Git" %}
73+
{%- set slug_2 = "git-integration" %}
74+
{%- set icon_2 = "fa-code-commit" -%}
75+
<a href="#{{ slug_2 }}" class="ui small header item">
76+
<i class="fad {{ icon_2 }} secondary big icon"></i>
77+
<span class="content">
78+
{{ header_2 }}
79+
<span class="sub header">Collaborate with your team by following the pull request and review workflow.</span>
80+
</span>
81+
</a>
82+
83+
{%- set header_3 = "Pull request previews" %}
84+
{%- set slug_3 = "pull-request-previews" %}
85+
{%- set icon_3 = "fa-file-plus-minus" -%}
86+
<a href="#{{ slug_3 }}" class="ui small header item">
87+
<i class="fad {{ icon_3 }} secondary big icon"></i>
88+
<span class="content">
89+
{{ header_3 }}
90+
<span class="sub header">Verify changes to your documentation with a fully built documentation website for each pull request.</span>
91+
</span>
92+
</a>
93+
94+
{%- set header_4 = "One-click deployment" %}
95+
{%- set slug_4 = "one-click-deployment" %}
96+
{%- set icon_4 = "fa-rocket" -%}
97+
<a href="#{{ slug_4 }}" class="ui small header item">
98+
<i class="fad {{ icon_4 }} secondary big icon"></i>
99+
<span class="content">
100+
{{ header_4 }}
101+
<span class="sub header">Automatically deploy your docs each time you <em>merge to main</em>.</span>
102+
</span>
103+
</a>
104+
105+
</div>
106+
</div>
107+
</div>
108+
109+
</div>
110+
</div>
111+
</div>
112+
113+
</section>
114+
115+
{% macro about_divide(text=None) %}
116+
<div class="ui text container">
117+
<div class="ui {%- if text %} horizontal {%- endif %} divider">
118+
{% if text %}{{ text }}{% endif %}
119+
</div>
120+
</div>
121+
{% endmacro %}
122+
123+
{{ about_divide() }}
124+
125+
<section>
126+
<div class="ui very padded container">
127+
<div class="ui vertically padded centered grid" id="{{ slug_1 }}">
128+
129+
{% call about.step(
130+
header=header_1,
131+
image="/images/usage/code-editor-light.png",
132+
image_alt="Visual Studio Code editor",
133+
icon=icon_1) %}
134+
{% markdown %}
135+
Write documentation using your favourite editor.
136+
Read the Docs doesn't force you to use any particular, WebUI, or WYSIWYG editor.
137+
You can use the one you already love.
138+
{% endmarkdown %}
139+
{% endcall %}
140+
141+
</div>
142+
</div>
143+
144+
{{ about_divide() }}
145+
146+
<div class="ui very padded container" id="{{ slug_2 }}">
147+
<div class="ui vertically padded centered grid">
148+
149+
{% call about.step(
150+
header=header_2,
151+
image="/images/usage/pull-request-collaboration.png",
152+
image_alt="Opened pull request on GitHub",
153+
icon=icon_2) %}
154+
{% markdown %}
155+
Once you are done writing the documentation, push you changes to Git and open a pull request to collaborate with your team.
156+
Accept or reject suggestions from your co-workers while previewing the live changes on Read the Docs.
157+
{% endmarkdown %}
158+
159+
<a class="ui basic primary button" href="https://docs.readthedocs.io/page/reference/git-integration.html">
160+
<i class="fad fa-book icon" aria-hidden="true"></i>
161+
Documentation
162+
</a>
163+
164+
{% endcall %}
165+
166+
</div>
167+
</div>
168+
169+
{{ about_divide() }}
170+
171+
<div class="ui very padded container" id="{{ slug_3 }}">
172+
<div class="ui vertically padded centered grid">
173+
174+
{% call about.step(
175+
header=header_3,
176+
image="/images/docs-as-code/visual-diff.png",
177+
image_alt="Visual diff between two versions",
178+
icon=icon_3) %}
179+
{% markdown %}
180+
When the pull request opened, you and your team can see the live changes on Read the Docs to evaluate the look & feel,
181+
but also to find style issues that are impossible to find out from the diff code in the pull request.
182+
{% endmarkdown %}
183+
184+
<a class="ui basic primary button" href="https://docs.readthedocs.io/page/pull-requests.html">
185+
<i class="fad fa-book icon" aria-hidden="true"></i>
186+
Documentation
187+
</a>
188+
189+
{% endcall %}
190+
191+
</div>
192+
</div>
193+
194+
{{ about_divide() }}
195+
196+
<div class="ui very padded container" id="{{ slug_4 }}">
197+
<div class="ui vertically padded centered grid">
198+
199+
{% call about.step(
200+
header=header_4,
201+
image="/images/usage/documentation.png",
202+
image_alt="Documentation built on Read the Docs",
203+
icon=icon_4) %}
204+
{% markdown %}
205+
After getting an approval in your pull request and you merged it,
206+
Read the Docs will build and deploy those changes in production automatically.
207+
{% endmarkdown %}
208+
209+
{# TODO: Have a better docs page for deployment #}
210+
<a class="ui basic primary button" href="https://docs.readthedocs.io/page/builds.html">
211+
<i class="fad fa-book icon" aria-hidden="true"></i>
212+
Documentation
213+
</a>
214+
215+
{% endcall %}
216+
217+
</div>
218+
</div>
219+
220+
</section>
221+
222+
223+
{# Try it out code block #}
224+
{% include "includes/try-it-out.html" %}
225+
226+
{% block bottom_callout %}
227+
<section>
228+
<div class="ui very padded container">
229+
<div class="ui grid center aligned">
230+
<div class="row">
231+
<div class="column twelve wide computer sixteen wide tablet">
232+
<div class="ui basic vertical huge segment">
233+
<h2 class="ui center aligned header">
234+
Save time and headaches!
235+
</h2>
236+
237+
<p>
238+
Simplify you day to day work by writing, building, previewing and publishing your documentation with Read the Docs.
239+
Collaborate with all your team in an easy way that everybody understands and can immediately see the changes after pushing them to Git.
240+
</p>
241+
242+
<p>
243+
<a class="ui large teal stackable button"
244+
data-analytics="signup-modal"
245+
onclick="jQuery('#signup-modal').modal('show');">
246+
<i class="fad fa-rocket icon"></i>
247+
Sign up now
248+
</a>
249+
</p>
250+
</div>
251+
</div>
252+
</div>
253+
</div>
254+
</div>
255+
</section>
256+
{% endblock bottom_callout %}
257+
258+
</body>
259+
</html>

0 commit comments

Comments
 (0)