diff --git a/content/images/usage/code-editor-light.png b/content/images/usage/code-editor-light.png new file mode 100644 index 00000000..c8f02780 Binary files /dev/null and b/content/images/usage/code-editor-light.png differ diff --git a/content/images/usage/code-editor.png b/content/images/usage/code-editor.png new file mode 100644 index 00000000..fe2d23b3 Binary files /dev/null and b/content/images/usage/code-editor.png differ diff --git a/content/images/usage/documentation.png b/content/images/usage/documentation.png new file mode 100644 index 00000000..2424db7a Binary files /dev/null and b/content/images/usage/documentation.png differ diff --git a/content/images/usage/pull-request-collaboration.png b/content/images/usage/pull-request-collaboration.png new file mode 100644 index 00000000..163c00b6 Binary files /dev/null and b/content/images/usage/pull-request-collaboration.png differ diff --git a/content/includes/try-it-out.html b/content/includes/try-it-out.html index 58968c37..28bba1c7 100644 --- a/content/includes/try-it-out.html +++ b/content/includes/try-it-out.html @@ -20,11 +20,11 @@

```yaml version: 2 build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: "3.10" + python: "3.12" # You can also specify other tool versions: - # nodejs: "16" + # nodejs: "20" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -96,4 +96,4 @@

- \ No newline at end of file + diff --git a/content/pages/usage.html b/content/pages/usage.html new file mode 100644 index 00000000..5e9cb11b --- /dev/null +++ b/content/pages/usage.html @@ -0,0 +1,265 @@ +{# + The goal of this page is to explain in a simple way how users will use Read the Docs in their lives. +#} + + + Using Read the Docs daily + + + + + + + +{# + View this page at http://localhost:8080/usage/index.html +#} + +{% import "partials/basic.html" as basic %} +{% import "partials/features.html" as about %} +{% import "partials/marketing.html" as marketing %} +{% import "partials/technical.html" as technical %} +{% import "partials/homepage.html" as homepage %} + +
+
+
+
+ +
+
+

+ Read the Docs in your daily work +

+ +

+ Read the Docs helps you with building, reviewing and publishing documentation for your customers + by following the docs as code pattern that you may be already using. + Allow your readers to browse different versions of your documentation, switch between langauges and perform searches accross all your projects. + They will appreciate you are using Read the Docs for your documentation. +

+ +
+
Write documentation using a rich ecosystem of tools and markups.
+
Preview each change before publishing.
+
Automatically deploy the documentation on merge.
+
Expose different versions of your documentation to readers.
+
+ +

+ Read the Docs is the all-in-one solution for docs as code. +

+ +
+
+ +
+
+
+ + {%- set header_1 = "Write the documentation" %} + {%- set slug_1 = "write" %} + {%- set icon_1 = "fa-pencil" -%} + + + + {{ header_1 }} + Write the documentation using your favourite editor and tool. + + + + {%- set header_2 = "Push the changes to Git" %} + {%- set slug_2 = "git-integration" %} + {%- set icon_2 = "fa-code-commit" -%} + + + + {{ header_2 }} + Collaborate with your team by following the pull request and review workflow. + + + + {%- set header_3 = "Preview your pull request" %} + {%- set slug_3 = "pull-request-previews" %} + {%- set icon_3 = "fa-file-plus-minus" -%} + + + + {{ header_3 }} + Verify changes to your documentation with a fully built documentation website for each pull request. + + + + {%- set header_4 = "Deploy with one click" %} + {%- set slug_4 = "one-click-deployment" %} + {%- set icon_4 = "fa-rocket" -%} + + + + {{ header_4 }} + Automatically deploy your documentation each time you merge to main. + + + +
+
+
+ +
+
+
+ +
+ +{% macro about_divide(text=None) %} +
+
+ {% if text %}{{ text }}{% endif %} +
+
+{% endmacro %} + +{{ about_divide() }} + +
+
+
+ + {% call about.step( + header=header_1, + image="/images/usage/code-editor-light.png", + image_alt="Visual Studio Code editor", + icon=icon_1) %} + {% markdown %} + Write documentation using your favourite editor and tool. + Read the Docs doesn't force you to use any one in particular. + No WebUI, or WYSIWYG editor. No lock-in. + You can use the one you already love. + {% endmarkdown %} + + + + Documentation + + + {% endcall %} + +
+
+ + {{ about_divide() }} + +
+
+ + {% call about.step( + header=header_2, + image="/images/usage/pull-request-collaboration.png", + image_alt="Opened pull request on GitHub", + icon=icon_2) %} + {% markdown %} + Once you are done writing the documentation, push you changes to Git and open a pull request to collaborate with your team. + Accept or reject suggestions from your co-workers while previewing the live changes on Read the Docs. + {% endmarkdown %} + + + + Documentation + + + {% endcall %} + +
+
+ + {{ about_divide() }} + +
+
+ + {% call about.step( + header=header_3, + image="/images/docs-as-code/visual-diff.png", + image_alt="Visual diff between two versions", + icon=icon_3) %} + {% markdown %} + When you open the pull request, you and your team can see the live changes on Read the Docs to evaluate the content, + but also looking for style and look & feel issues, that are impossible to find out from the diff code in the pull request. + {% endmarkdown %} + + + + Documentation + + + {% endcall %} + +
+
+ + {{ about_divide() }} + +
+
+ + {% call about.step( + header=header_4, + image="/images/usage/documentation.png", + image_alt="Documentation built on Read the Docs", + icon=icon_4) %} + {% markdown %} + After getting an approval in your pull request from your team and merging it, + Read the Docs will build and deploy those changes to production automatically. + {% endmarkdown %} + + {# TODO: Have a better docs page for deployment #} + + + Documentation + + + {% endcall %} + +
+
+ +
+ + +{# Try it out code block #} +{% include "includes/try-it-out.html" %} + +{% block bottom_callout %} +
+
+
+
+
+
+

+ Save time and headaches! +

+ +

+ Simplify you day to day work by writing, building, previewing and publishing your documentation with Read the Docs. + Collaborate with all your team in an easy way that everybody understands and can immediately see the changes after pushing them to Git. +

+ +

+ + + Sign up now + +

+
+
+
+
+
+
+ {% endblock bottom_callout %} + + +