Skip to content

Product page template #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Jan 27, 2022
Merged

Product page template #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
eca1e3d
Add homepage template contents
nienn Jan 13, 2022
1396147
Update images
nienn Jan 13, 2022
2e695b5
Remove inkscape stuff from logo-wordmark-dark.svg
nienn Jan 13, 2022
0c4c952
Move announcements to a separate file
nienn Jan 18, 2022
69735f1
Add product page template
nienn Jan 18, 2022
518fe85
Commit copy suggestion
nienn Jan 19, 2022
c9d6f8f
Commit copy suggestion
nienn Jan 19, 2022
fa2e5da
Commit copy suggestion
nienn Jan 19, 2022
b7ac83a
Commit copy suggestion
nienn Jan 19, 2022
b45d2b8
Commit copy suggestion
nienn Jan 19, 2022
3f2eace
Commit copy suggestion
nienn Jan 19, 2022
fa28eeb
Revision update
nienn Jan 19, 2022
1ba416e
Merge branch 'nienn/product-page-template' of github.com:readthedocs/…
nienn Jan 19, 2022
cf1bfce
Update product.md contents
nienn Jan 24, 2022
092f640
Port copy changes from #23 mockup review
nienn Jan 25, 2022
f9f681a
Use Wikipedia style guide on bullet lists
nienn Jan 25, 2022
5203a0b
Revise "Docs as code" copy
nienn Jan 25, 2022
f072830
Add blog links and update buttons copy
nienn Jan 25, 2022
7532435
Update buttons copy
nienn Jan 26, 2022
06ad908
Merge branch 'main' into nienn/product-page-template
agjohnson Jan 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/pages/product.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
title: Product
subtitle:
template: readthedocs/product
save_as: product.html
status: hidden
description:
248 changes: 248 additions & 0 deletions readthedocs-theme/templates/readthedocs/product.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
{% extends "page.html" %}

{% block body_id %}product{% endblock %}

{% block content %}

<!-- User Segments -->
<section class="ui vertical segment inverted padded" id="user-segments">

<div class="ui container">
<div class="ui grid stackable three column">

<div class="column">

<div>
<h3 class="ui header inverted">Write docs like you code</h3>
<p>
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.
</p>

<div class="ui list inverted relaxed divided">

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Issue tracking</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Version control</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Write your docs in plain text for easy review and translation</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Preview documentation changes before they are merged</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Receive a Slack notification if your documentation build fails</div>
</div>
</div>

</div>

</div>

<div>
<a href="https://docs.readthedocs.io/en/stable/guides/developers.html" class="ui button green fluid">Learn about the engineering workflow</a>
</div>
</div>

<div class="column">
<div>
<h3 class="ui header inverted">Write with reStructuredText or Markdown</h3>
<p>
Write documentation alongside your code, with all your same tools, enabling a culture where writers and developers both feel ownership of documentation.
</p>

<div class="ui list inverted relaxed divided">

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Empower your developers to write docs</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Include internal and external cross references</div>
</div>
</div>

</div>

</div>
<div>
<a href="https://docs.readthedocs.io/en/stable/guides/authors.html" class="ui button green fluid">Guides for documentation authors</a>
</div>
</div>

<div class="column">
<div>
<h3 class="ui header inverted">Easy documentation deployment for technical teams</h3>
<p>
We deploy and host your team's documentation automatically. With pull request previews you can validate all your changes, before they go live. Once you commit, we keep your documentation up to date, across all versions of your software.
</p>

<div class="ui list inverted relaxed divided">

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Always up to date</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Automatic documentation updates</div>
</div>
</div>

<div class="item">
<i class="icon check circle green"></i>
<div class="content">
<div class="description">Host multiple documentation versions</div>
</div>
</div>

</div>

</div>
<div>
<a href="https://docs.readthedocs.io/en/stable/guides/administrators.html" class="ui button green fluid">Guides for project administrators</a>
</div>
</div>

</div>
</div>

</section>

<!-- Features -->
<section class="ui vertical segment light padded" id="features">
<div class="ui container">
<h2 class="ui header">Features</h2>

<div class="ui two stackable cards">

<div class="card">
<div class="content">
<h4>Multiple formats</h4>
<p>
Of course we build and host your docs for the web, but they are
also viewable as PDFs, as single page HTML, and for eReaders.
No additional configuration is required.
</p>
</div>
<div class="extra content">
<div class="ui labels">
<span class="ui label basic large"><i class="icon primary code"></i> HTML</span>
<span class="ui label basic large"><i class="icon primary file alternate outline"></i> PDF</span>
</div>
</div>
</div>

<div class="card">
<div class="content">
<h4>Multiple versions</h4>
<p>
We can host and build multiple versions of your docs so having a
1.0 version of your docs and a 2.0 version of your docs is as easy
as having a separate branch or tag in your version control system.
</p>
</div>
<div class="extra content">
<div class="ui labels">
<span class="ui label basic large"><i class="icon primary hourglass outline"></i> Version control</span>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Version control" could speak more to "Multiple versions". Perhaps the bullet points should mention support for branches and tags, and support for automated actions using automation rules.

</div>
</div>
</div>

<div class="card">
<div class="content">
<h4>Write docs with Sphinx or Mkdocs</h4>
<p>
Documentation can be written in Markdown or reStructuredText. Write just prose documentation, or automatically pull in documentation that is written inside your code (eg. Python docstrings).
</p>
</div>
<div class="extra content">
<div class="ui labels">
<span class="ui label basic large"><i class="icon primary hourglass outline"></i> reStructuredText</span>
<span class="ui label basic large"><i class="icon primary hourglass outline"></i> Markdown</span>
</div>
</div>
</div>

<div class="card">
<div class="content">
<h4>We build your docs on every pull request or merge</h4>
<p>
Whenever you push a commit, we build your full set of documentation and provide a fully working preview. If you decide to merge into a production version, we will update that on merge. Your docs are always up to date with your code.
</p>
</div>
<div class="extra content">
<div class="ui labels">
<span class="ui label basic large"><i class="icon primary hourglass outline"></i> Always up to date</span>
</div>
</div>
</div>

<div class="card">
<div class="content">
<h4>The same tools your team is already using</h4>
<p>
All too often, when documentation is lacking, it's because maintaining documentation is too difficult. Using developer tools like Git lowers the bar contributing documentation, meaning your docs will see more frequent updates.
</p>
</div>
<div class="extra content">
<div class="ui labels">
<span class="ui label basic large"><i class="icon primary hourglass outline"></i> Use familiar tools</span>
<span class="ui label basic large"><i class="icon primary hourglass outline"></i> Write docs like you code</span>
</div>
</div>
</div>

<div class="card">
<div class="content">
<h4>Webhooks</h4>
<p>
Whenever you push code to your favorite version control system,
whether that is Git, Mercurial, Bazaar, or Subversion, we will
automatically build your docs so your code and documentation are
never out of sync.
</p>
</div>
<div class="extra content">
<div class="ui labels">
<span class="ui label basic large"><i class="icon primary github"></i> GitHub</span>
<span class="ui label basic large"><i class="icon primary gitlab"></i> GitLab</span>
<span class="ui label basic large"><i class="icon primary bitbucket"></i> Bitbucket</span>
</div>
</div>
</div>

</div>
</div>
</section>

{% endblock content %}