diff --git a/docs/user/commercial/index.rst b/docs/user/commercial/index.rst index 8107d0f6ef8..6e834f4a2ae 100644 --- a/docs/user/commercial/index.rst +++ b/docs/user/commercial/index.rst @@ -37,7 +37,7 @@ Advertising-free Business features Enjoy additional functionality specifically for larger organizations such as - team management, single-sign on, and audit logging. + team management, single sign-on, and audit logging. .. seealso:: diff --git a/docs/user/commercial/organizations.rst b/docs/user/commercial/organizations.rst index c486da13f0c..3b8fcf6d34e 100644 --- a/docs/user/commercial/organizations.rst +++ b/docs/user/commercial/organizations.rst @@ -25,7 +25,7 @@ The best way to think about this relationship is: .. warning:: - Owners, Members and Teams behave differently if you are using + Owners, Members, and Teams behave differently if you are using :ref:`sso_git_provider`. Team types @@ -40,7 +40,7 @@ Example ~~~~~~~ ACME would set up *Owners* of their organization, -for example Frank Roadrunner would be an owner. +for example, Frank Roadrunner would be an owner. He has full access to the organization and all projects. Wile E. Coyote is a contractor, diff --git a/docs/user/commercial/privacy-level.rst b/docs/user/commercial/privacy-level.rst index 25dd1afa743..5133c51cfc7 100644 --- a/docs/user/commercial/privacy-level.rst +++ b/docs/user/commercial/privacy-level.rst @@ -1,4 +1,4 @@ -Privacy Levels +Privacy levels -------------- .. include:: /shared/admonition-rtd-business.rst diff --git a/docs/user/commercial/sharing.rst b/docs/user/commercial/sharing.rst index f17d975c1a6..a41f3035c20 100644 --- a/docs/user/commercial/sharing.rst +++ b/docs/user/commercial/sharing.rst @@ -20,7 +20,7 @@ Creating a shared item * Select access type (secret link, password, or HTTP header token), add an expiration date and a *Description* to help with managing access in the future. * Check ``Allow access to all versions?`` if you want to grant access to all versions, - or uncheck that option and select the specific versions you want grant access to. + or uncheck that option and select the specific versions you want to grant access to. * Click :guilabel:`Save`. * Get the info needed to share your documentation with other users: @@ -32,7 +32,7 @@ Creating a shared item .. note:: - You can always revoke access by removing the sharing item in this page. + You can always revoke access by removing the sharing item on this page. Sharing methods --------------- @@ -93,12 +93,11 @@ For example: curl --url https://docs.example.com/en/latest/example.html --user '$TOKEN:' - Typical sharing configurations ------------------------------ There are a few common ways to architect sharing, -with trade offs between them, +with trade-offs between them, and you should choose the one that best fits your use case. Bulk passwords @@ -132,7 +131,7 @@ If you want a more transparent experience for your users, you can create a proxy that authenticates users against your system, and then proxies the request to Read the Docs. This is more complex to set up, -but will allow users to access the documentation directly from a bookmark, +but will allow users to access the documentation directly from a bookmark. This approach would use a :ref:`commercial/sharing:HTTP Authorization Header` to authenticate users, and would be configured in your proxy server. diff --git a/docs/user/commercial/subscriptions.rst b/docs/user/commercial/subscriptions.rst index 3aea287b633..90edabe1ba9 100644 --- a/docs/user/commercial/subscriptions.rst +++ b/docs/user/commercial/subscriptions.rst @@ -10,7 +10,7 @@ It's easy to achieve a number of common tasks in this dashboard: * View, download, and pay invoices. * Add additional tax (VAT/EIN) or contact email addresses on your invoices. -You can always find our most up to date pricing information on our `pricing page `_. +You can always find our most up-to-date pricing information on our `pricing page `_. Managing your subscription -------------------------- @@ -32,7 +32,7 @@ Cancelling your subscription can be done following the instructions in `Managing Your subscription will remain active for the remainder of the current billing period, and will not renew for the next billing period. -**We can not cancel subscriptions through an email request, +**We cannot cancel subscriptions through an email request, as email is an insecure method of verifying a user's identity.** If you email us about this, we require you to verify your identity by logging into your Read the Docs account and submitting an official support request there. @@ -65,5 +65,5 @@ is generally where we recommend most academic projects to host their projects. If you have constraints on how public your documentation can be, our commercial hosting is probably a better fit. -We offer a 50% discount on our all of our commercial plans to certified academic and non-profit organizations. +We offer a 50% discount on all of our commercial plans to certified academic and non-profit organizations. Please contact :doc:`/support` to request this discount. diff --git a/docs/user/intro/accounts.rst b/docs/user/intro/accounts.rst index 2509a99b4af..9653142f170 100644 --- a/docs/user/intro/accounts.rst +++ b/docs/user/intro/accounts.rst @@ -4,7 +4,7 @@ Account authentication methods Read the Docs supports several authentication methods for creating an account and logging in. The method you choose depends on your preferences and the security requirements of your organization. -These authentication methods are not mutually exclusive, +These authentication methods are not mutually exclusive; you can use multiple methods to access your account. Email and password @@ -42,7 +42,7 @@ Google authentication works well for users already using Google services, and easily integrates into your existing workflow. Google provides authentication, but not authorization. -This means that you can login to Read the Docs with this method, +This means that you can log in to Read the Docs with this method, but we aren't able to determine which projects you have access to automatically. .. seealso:: @@ -61,7 +61,7 @@ This is only available on Enterprise plans, and requires custom integration to be enabled. SAML provides authentication, but not authorization. -This means that users can login to Read the Docs with this method, +This means that users can log in to Read the Docs with this method, but we aren't able to determine which projects each user has access to automatically. .. seealso:: diff --git a/docs/user/intro/add-project.rst b/docs/user/intro/add-project.rst index 2c3bc20478b..6dac5303cda 100644 --- a/docs/user/intro/add-project.rst +++ b/docs/user/intro/add-project.rst @@ -5,7 +5,7 @@ Adding a documentation project :description lang=en: Add your existing documentation from a Git repository into Read the Docs. This page takes you through the process of adding a documentation project to Read the Docs. -If you have :doc:`connected your Read the Docs account ` to GitHub, Bitbucket or GitLab you will be able to add your project automatically. +If you have :doc:`connected your Read the Docs account ` to GitHub, Bitbucket, or GitLab, you will be able to add your project automatically. Otherwise, you will need to add it manually and perform some extra steps. Automatically add your project @@ -17,7 +17,7 @@ Automatically add your project #. Click on :guilabel:`Continue`. #. Edit any of the pre-filled fields with information of the repository. #. Click on :guilabel:`Next`. -#. Add a :term:`configuration file` to your repository if it's doesn't exist yet. +#. Add a :term:`configuration file` to your repository if it doesn't exist yet. #. Click on :guilabel:`This file exists`. .. seealso:: @@ -35,7 +35,7 @@ Manually add your project #. Click on :guilabel:`Continue`. #. Fill all the fields of the form. #. Click on :guilabel:`Next`. -#. Add a :term:`configuration file` to your repository if it's doesn't exist yet. +#. Add a :term:`configuration file` to your repository if it doesn't exist yet. #. Click on :guilabel:`This file exists`. Once your project is created, you'll need to manually configure the repository webhook if you would like to have new changes trigger builds for your project on Read the Docs. @@ -45,7 +45,6 @@ Once your project is created, you'll need to manually configure the repository w :doc:`/guides/setup/git-repo-manual` Additional setup steps required for manually created projects. This guide covers setting up SSH keys and webhook integrations. - What's next ----------- diff --git a/docs/user/intro/doctools.rst b/docs/user/intro/doctools.rst index b6068a1cedd..fb4bac2d21f 100644 --- a/docs/user/intro/doctools.rst +++ b/docs/user/intro/doctools.rst @@ -2,7 +2,7 @@ Popular documentation tools =========================== Read the Docs provides documentation hosting for any tool that can output HTML. -We provide a number of features on top of that that is well-suited to documentation specifically, +We provide a number of features that are well-suited to documentation specifically, but you can host any kind of HTML content on Read the Docs. Below is a list of popular documentation tools that you can use to write your documentation. diff --git a/docs/user/intro/docusaurus.rst b/docs/user/intro/docusaurus.rst index c89d479ad85..148dac6a63c 100644 --- a/docs/user/intro/docusaurus.rst +++ b/docs/user/intro/docusaurus.rst @@ -1,5 +1,5 @@ -Docusarus -========= +Docusaurus +========== .. meta:: :description lang=en: Hosting Docusaurus sites on Read the Docs. @@ -7,7 +7,7 @@ Docusarus `Docusaurus`_ is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features. Minimal configuration required to build a Docusaurus project on Read the Docs looks like this, -specifying a nodejs toolchain on Ubuntu, using multiple :ref:`build ` jobs to install the requirements, +specifying a Node.js toolchain on Ubuntu, using multiple :ref:`build ` jobs to install the requirements, build the site, and copy the output to $READTHEDOCS_OUTPUT: .. code-block:: yaml @@ -15,16 +15,16 @@ build the site, and copy the output to $READTHEDOCS_OUTPUT: version: 2 build: - os: "ubuntu-22.04" - tools: + os: "ubuntu-22.04" + tools: nodejs: "18" - jobs: + jobs: # "docs/" was created following the Docusaurus tutorial: # npx create-docusaurus@latest docs classic # but you can just use your existing Docusaurus site install: - # Install Docusaurus dependencies - - cd docs/ && npm install + # Install Docusaurus dependencies + - cd docs/ && npm install build: html: # Build the site @@ -42,22 +42,20 @@ Limitations :header: "Feature", "Description", "Supported" "Search", "Provides full-text search capabilities.", "Not supported" - "Files changed", "Ability to see what HTML files changes in pull request previews", "Not supported" - + "Files changed", "Ability to see what HTML files change in pull request previews.", "Not supported" Quick start ----------- - If you have an existing Docusaurus project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide. - - If you're new to Docusaurus, check out the official `Fast Track`_ guide. .. _Fast Track: https://docusaurus.io/docs#fast-track -Configuring Docusaurus and Read the Docs addons +Configuring Docusaurus and Read the Docs Addons ----------------------------------------------- -For optimal integration with Read the Docs, make the optional following configuration changes to your Docusaurus config. +For optimal integration with Read the Docs, make the following optional configuration changes to your Docusaurus config. .. contents:: :depth: 1 @@ -70,7 +68,7 @@ Set the canonical URL A :doc:`canonical URL ` allows you to specify the preferred version of a web page to prevent duplicated content. -Set your Docusaurus `url`_ to your Read the Docs canonical URL using `dotenv `__ and a +Set your Docusaurus `url`_ to your Read the Docs canonical URL using `dotenv `__ and a :doc:`Read the Docs environment variable `: .. code-block:: js diff --git a/docs/user/intro/markdoc.rst b/docs/user/intro/markdoc.rst index 58b6ee0e08e..720379131a8 100644 --- a/docs/user/intro/markdoc.rst +++ b/docs/user/intro/markdoc.rst @@ -34,7 +34,7 @@ Example configuration --------------------- In order to build a Markdoc project on Read the Docs, -you need to generate static HTML from the Next JS build: +you need to generate static HTML from the Next.js build: .. code-block:: js :caption: next.config.js diff --git a/docs/user/intro/mdbook.rst b/docs/user/intro/mdbook.rst index 890b5f79a21..19363cb7530 100644 --- a/docs/user/intro/mdbook.rst +++ b/docs/user/intro/mdbook.rst @@ -14,17 +14,17 @@ Minimal configuration is required to build an existing mdBook project on Read th version: 2 build: - os: ubuntu-lts-latest - tools: - rust: latest - jobs: - install: - - cargo install mdbook - build: - html: - # For an example book.. - # - mdbook init docs - - mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html + os: ubuntu-lts-latest + tools: + rust: latest + jobs: + install: + - cargo install mdbook + build: + html: + # For an example book.. + # - mdbook init docs + - mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html .. _mdBook: https://rust-lang.github.io/mdBook/ @@ -36,7 +36,6 @@ Getting started .. _Getting started with mdBook: https://rust-lang.github.io/mdBook/guide/creating.html - Example repository and demo --------------------------- diff --git a/docs/user/intro/mkdocs.rst b/docs/user/intro/mkdocs.rst index 550e4570914..ec4c9d8b8a1 100644 --- a/docs/user/intro/mkdocs.rst +++ b/docs/user/intro/mkdocs.rst @@ -5,7 +5,7 @@ MkDocs :description lang=en: Hosting MkDocs sites on Read the Docs. `MkDocs`_ is a fast, simple static site generator that's geared towards building project documentation. -Mkdocs is written in Python, and supports documentation written in Markdown. +MkDocs is written in Python, and supports documentation written in Markdown. When using MkDocs, we recommend using the `Material for MkDocs`_ theme, and this guide is mostly focused on the integration required to make it work well on Read the Docs. @@ -68,7 +68,7 @@ Set the canonical URL A :doc:`canonical URL ` allows you to specify the preferred version of a web page to prevent duplicated content. -Set your MkDocs `site URL`_ to your Read the Docs canonical URL using a +Set your MkDocs `site URL`_ to your Read the Docs canonical URL using a :doc:`Read the Docs environment variable `: .. code-block:: yaml @@ -76,7 +76,7 @@ Set your MkDocs `site URL`_ to your Read the Docs canonical URL using a site_url: !ENV READTHEDOCS_CANONICAL_URL -.. _Site URL: https://www.mkdocs.org/user-guide/configuration/#site_url +.. _site URL: https://www.mkdocs.org/user-guide/configuration/#site_url Configuring Material for MkDocs and Read the Docs Addons -------------------------------------------------------- @@ -114,18 +114,16 @@ To configure your site to use :doc:`Read the Docs search ` command, +specifying a Python 3.x toolchain on Ubuntu, using the built-in :ref:`sphinx ` command, and defining the location of the installation requirements: - .. code-block:: yaml :caption: .readthedocs.yaml - version: 2 + version: 2 - build: - os: ubuntu-24.04 - tools: - python: "3" + build: + os: ubuntu-24.04 + tools: + python: "3" - sphinx: - configuration: docs/conf.py + sphinx: + configuration: docs/conf.py - python: - install: - - requirements: requirements.txt + python: + install: + - requirements: requirements.txt .. _Sphinx: https://www.sphinx-doc.org @@ -36,18 +35,15 @@ Quick start ----------- - If you have an existing Sphinx project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide. - - If you're new to Sphinx, check out the official `Getting started with Sphinx`_ guide. - -- For a step by step tutorial on Read the Docs using an example Sphinx project, take a look at the :doc:`/tutorial/index`. +- For a step-by-step tutorial on Read the Docs using an example Sphinx project, take a look at the :doc:`/tutorial/index`. .. _Getting started with Sphinx: https://www.sphinx-doc.org/en/master/usage/quickstart.html - -Configuring Sphinx and Read the Docs addons +Configuring Sphinx and Read the Docs Addons ------------------------------------------- -For optimal integration with Read the Docs, make the optional following configuration changes to your Spinx config. +For optimal integration with Read the Docs, make the following optional configuration changes to your Sphinx config. .. contents:: :depth: 1 @@ -60,7 +56,7 @@ Set the canonical URL A :doc:`canonical URL ` allows you to specify the preferred version of a web page to prevent duplicated content. -Set your `html_baseurl`_ to your Read the Docs canonical URL using a +Set your `html_baseurl`_ to your Read the Docs canonical URL using a :doc:`Read the Docs environment variable `: .. code-block:: py @@ -68,7 +64,6 @@ Set your `html_baseurl`_ to your Read the Docs canonical URL using a html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/") - .. _html_baseurl: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl Configure Read the Docs search @@ -84,7 +79,6 @@ If you're using a different theme, enable :doc:`Server side search { @@ -104,7 +98,7 @@ If you're using a different theme, enable :doc:`Server side search `__, the :ref:`flyout-menu:Addons flyout menu` is already fully integrated into the theme. Use the theme options `flyout_display `__, `version_selector `__, `language_selector `__ to configure it. @@ -116,7 +110,7 @@ Using Markdown with Sphinx -------------------------- You can use `Markdown using MyST`_ and reStructuredText in the same Sphinx project. -We support this natively on Read the Docs, and you can also use locally by installing ``myst-parser``: +We support this natively on Read the Docs, and you can also use it locally by installing ``myst-parser``: .. prompt:: bash $ @@ -140,7 +134,6 @@ You can now continue writing your docs in ``.md`` files and it will work with Sp .. _Markdown using MyST: https://myst-parser.readthedocs.io/en/latest/using/intro.html - Example repository and demo --------------------------- diff --git a/docs/user/reference/404-not-found.rst b/docs/user/reference/404-not-found.rst index f083310f40e..bc21dee8a4a 100644 --- a/docs/user/reference/404-not-found.rst +++ b/docs/user/reference/404-not-found.rst @@ -13,7 +13,7 @@ we check if there is a ``404.html`` or ``404/index.html`` in the root of your pr The following locations are checked, in order: * ``/404.html`` or ``404/index.html`` in the *current* documentation version. -* ``/404.html`` or ``404/index.html`` in the *default* documentation version. +* ``/404.html`` or ``404/index.html`` in the *default* documentation version. Tool integration ---------------- @@ -32,7 +32,7 @@ We have examples for some of the most popular tools below. See its documentation_ for how to install and customize it. If you want to create a custom ``404.html``, - Sphinx uses `html_extra_path`_ option to add static files to the output. + Sphinx uses the `html_extra_path`_ option to add static files to the output. You need to create a ``404.html`` file and put it under the path defined in ``html_extra_path``. If you are using the ``DirHTML`` builder, diff --git a/docs/user/reference/cdn.rst b/docs/user/reference/cdn.rst index 5dbb96a0b5f..e0ffaf14bfa 100644 --- a/docs/user/reference/cdn.rst +++ b/docs/user/reference/cdn.rst @@ -11,7 +11,7 @@ We support CDNs on both of our sites: we are able to provide a CDN to all the projects that we host. This service is graciously sponsored by `Cloudflare`_. * On |com_brand|, - the CDN is included as part of our all of our plans. + the CDN is included as part of all of our plans. We use `Cloudflare`_ for this as well. CDN benefits @@ -33,6 +33,6 @@ We automatically refresh the cache on the CDN when the following actions happen: By refreshing the cache according to these rules, readers should **never see outdated content**. -This makes the end-user experience seamless, and fast. +This makes the end-user experience seamless and fast. .. _Cloudflare: https://www.cloudflare.com/ diff --git a/docs/user/reference/environment-variables.rst b/docs/user/reference/environment-variables.rst index c1ce5f252af..29172b1fb70 100644 --- a/docs/user/reference/environment-variables.rst +++ b/docs/user/reference/environment-variables.rst @@ -28,7 +28,7 @@ All :doc:`build processes ` have the following environment variables au The locale name, or the identifier for the locale, for the project being built. This value comes from the project's configured language code, - which is in lowercase and use a dash as a separator. + which is in lowercase and uses a dash as a separator. :Example: ``en`` :Example: ``it`` @@ -65,10 +65,10 @@ All :doc:`build processes ` have the following environment variables au .. envvar:: READTHEDOCS_OUTPUT - Base path for well-known output directories. Files in these directories will automatically be found, uploaded and published. + Base path for well-known output directories. Files in these directories will automatically be found, uploaded, and published. You need to concatenate an output format to this variable. - Currently valid formats are ``html``, ``pdf``, ``htmlzip`` and ``epub``. + Currently valid formats are ``html``, ``pdf``, ``htmlzip``, and ``epub``. (e.g. ``$READTHEDOCS_OUTPUT/html/`` or ``$READTHEDOCS_OUTPUT/pdf/``) You also need to create the directory before moving outputs into the destination. You can create it with the following command ``mkdir -p $READTHEDOCS_OUTPUT/html/``. diff --git a/docs/user/reference/features.rst b/docs/user/reference/features.rst index 2e15f9c980a..b6bf1884c1b 100644 --- a/docs/user/reference/features.rst +++ b/docs/user/reference/features.rst @@ -42,7 +42,7 @@ Feature reference with advanced functionality like folder redirects. ⏩️ :doc:`/commercial/sharing` - It is possible to host private and password protected documentation on Read the Docs for Business. + It is possible to host private and password-protected documentation on Read the Docs for Business. ⏩️ :doc:`/reference/cdn` Documentation projects are primarily static HTML pages along with media files. diff --git a/docs/user/reference/git-integration.rst b/docs/user/reference/git-integration.rst index 78dec2d2e4c..d2863677c80 100644 --- a/docs/user/reference/git-integration.rst +++ b/docs/user/reference/git-integration.rst @@ -35,7 +35,7 @@ Getting started ⏩️️ Signed up with your email address? If you have signed up to Read the Docs with your email address, - you can add the connection to the Git provider afterwards. + you can add the connection to the Git provider afterward. You can also add a connection to an additional Git provider this way. Please follow :doc:`/guides/connecting-git-account` in this case. @@ -48,7 +48,7 @@ How automatic configuration works When your Read the Docs account is connected to |git_providers_or| and you :doc:`add a new Read the Docs project `: -* Read the Docs automatically creates a Read the Docs Integration that matches your Git provider, +* Read the Docs automatically creates a Read the Docs Integration that matches your Git provider. * Read the Docs creates an incoming webhook with your Git provider, which is automatically added to your Git repository's settings using the account connection. After project creation, @@ -65,14 +65,14 @@ Read the Docs incoming webhook ------------------------------ Accounts with |git_providers_and| integration automatically have Read the Docs' incoming :term:`webhook` configured on all Git repositories that are imported. -Other setups can setup the webhook through :doc:`manual configuration `. +Other setups can set up the webhook through :doc:`manual configuration `. When an incoming webhook notification is received, Read the Docs ensures that it matches an existing project. Once the webhook is validated, an action is taken based on the information inside of the webhook. -Possible webhook actions outcomes are: +Possible webhook action outcomes are: * :doc:`Builds ` the latest commit. * Synchronizes your versions based on the latest tag and branch data in Git. @@ -93,7 +93,7 @@ See more in our :ref:`sso_git_provider`. How does the connection work? ----------------------------- -Read the Docs uses `OAuth`_ to connect to your account at |git_providers_or|, +Read the Docs uses `OAuth`_ to connect to your account at |git_providers_or|. You are asked to grant permissions for Read the Docs to perform a number of actions on your behalf. At the same time, we use this process for authentication (login) @@ -130,7 +130,7 @@ Permissions for connected accounts Read the Docs does not generally ask for *write* permission to your repository code (with one exception detailed below). However, we do need permissions for authorizing your account -so that you can login to Read the Docs with your connected account credentials. +so that you can log in to Read the Docs with your connected account credentials. .. tabs:: @@ -142,7 +142,7 @@ so that you can login to Read the Docs with your connected account credentials. .. _OAuth scopes: https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ Read access to your email address (``user:email``) - We ask for this so you can create a Read the Docs account and login with your GitHub credentials. + We ask for this so you can create a Read the Docs account and log in with your GitHub credentials. Administering webhooks (``admin:repo_hook``) We ask for this so we can create :term:`webhooks ` on your repositories when you import them into Read the Docs. @@ -154,13 +154,13 @@ so that you can login to Read the Docs with your connected account credentials. Repository status (``repo:status``) Repository statuses allow Read the Docs to report the status - (eg. passed, failed, pending) of pull requests to GitHub. + (e.g. passed, failed, pending) of pull requests to GitHub. .. note:: :doc:`Read the Docs for Business ` asks for one additional permission (``repo``) to allow access to private repositories - and to allow us to setup SSH keys to clone your private repositories. + and to allow us to set up SSH keys to clone your private repositories. Unfortunately, this is the permission for read/write control of the repository but there isn't a more granular permission that only allows setting up SSH keys for read access. @@ -175,7 +175,7 @@ so that you can login to Read the Docs with your connected account credentials. NB! This permission scope does **not** include any write access to code. Reading your account information including your email address - We ask for this so you can create a Read the Docs account and login with your Bitbucket credentials. + We ask for this so you can create a Read the Docs account and log in with your Bitbucket credentials. Read access to your team memberships We ask for this so we know which organizations you have access to. diff --git a/docs/user/reference/sitemaps.rst b/docs/user/reference/sitemaps.rst index d3144448721..53c26f782d4 100644 --- a/docs/user/reference/sitemaps.rst +++ b/docs/user/reference/sitemaps.rst @@ -8,16 +8,16 @@ and improves your :doc:`Search Engine Optimization (SEO) ` of your documentation and when it were last updated, +Read the Docs automatically generates a ``sitemap.xml`` for your project. +The sitemap includes :ref:`public and not hidden versions ` of your documentation and when they were last updated, sorted by version number. This allows search engines to prioritize results based on the version number, diff --git a/docs/user/server-side-search/index.rst b/docs/user/server-side-search/index.rst index ba89a5073c1..c76ed8b7c7d 100644 --- a/docs/user/server-side-search/index.rst +++ b/docs/user/server-side-search/index.rst @@ -3,8 +3,6 @@ Server side search Read the Docs provides full-text search across all of the pages of all projects, this is powered by Elasticsearch_. -You can search all projects at https://readthedocs.org/search/, -or search only on your project from the :guilabel:`Search` tab of your project. .. seealso:: @@ -33,7 +31,7 @@ Full control over which results should be listed first See :ref:`config-file/v2:search.ranking`. Search across projects you have access to - Search across all the projects you access to in your Dashboard. + Search across all the projects you have access to in your Dashboard. **Don't remember where you found that document the other day? No problem, you can search across them all.** diff --git a/docs/user/server-side-search/syntax.rst b/docs/user/server-side-search/syntax.rst index dccf8e8f81a..26262b349db 100644 --- a/docs/user/server-side-search/syntax.rst +++ b/docs/user/server-side-search/syntax.rst @@ -18,12 +18,12 @@ you can escape it like ``project\:docs``. .. note:: - Unknown parameters like ``foo:bar`` don't require escaping + Unknown parameters like ``foo:bar`` don't require escaping. The available parameters are: project - Indicates the project and version to includes results from + Indicates the project and version to include results from (this doesn’t include subprojects or translations). If the version isn’t provided, the default version will be used. More than one parameter can be included. @@ -36,8 +36,8 @@ project subprojects Include results from the given project and its subprojects. - If the version isn't provided, the default version of all projects will be used, - if a version is provided, all subprojects matching that version + If the version isn't provided, the default version of all projects will be used. + If a version is provided, all subprojects matching that version will be included, and if they don't have a version with that name, we use their default version. More than one parameter can be included. @@ -52,8 +52,8 @@ user Include results from projects the given user has access to. The only supported value is ``@me``, which is an alias for the current user. - Only one parameter can be included, - if duplicated, the last one will override the previous one. + Only one parameter can be included. + If duplicated, the last one will override the previous one. Examples: @@ -108,7 +108,7 @@ Prefix query ~~~~~~~~~~~~ ``*`` (asterisk) at the end of any term signifies a prefix query. -It returns the results containing the words with specific prefix. +It returns the results containing the words with the specific prefix. Examples: