Add TheEconomist and proselist rules from WTD (#12258)

ericholscher · web-flow · commit ad85c46bff59 · 2025-06-23T10:14:02.000-07:00
These add a bunch of standardized checks for language  --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--12258.org.readthedocs.build/12258/   - Developer's documentation (`dev`): https://dev--12258.org.readthedocs.build/12258/
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -61,7 +61,6 @@ jobs:
       - run: pip install --user tox
       - run: tox -e pre-commit
       - run: tox -e migrations
-      - run: tox -e vale
       - save_cache:
           key: pre-commit-cache-{{ checksum "pre-commit-cache-key.txt" }}
           paths:
diff --git a/.vale.ini b/.vale.ini
diff --git a/.vale.ini b/.vale.ini
@@ -0,0 +1 @@
+common/vale.ini
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -233,6 +233,9 @@ Version 12.0.0
 * `@ericholscher <https://github.com/ericholscher>`__: Hosting: Don't check for superprojects on subprojects (`#11683 <https://github.com/readthedocs/readthedocs.org/pull/11683>`__)
 * `@ericholscher <https://github.com/ericholscher>`__: Remove indexes that aren't used and that are large (`#11623 <https://github.com/readthedocs/readthedocs.org/pull/11623>`__)
 
+
+.. vale off
+
 Version 11.21.1
 ---------------
 
@@ -247,6 +250,9 @@ Version 11.21.1
 * `@humitos <https://github.com/humitos>`__: File Tree Diff: normalize ignore files (`#11987 <https://github.com/readthedocs/readthedocs.org/pull/11987>`__)
 * `@stsewd <https://github.com/stsewd>`__: Git service: depend on the project instead of users (`#11983 <https://github.com/readthedocs/readthedocs.org/pull/11983>`__)
 
+.. vale on
+
+
 Version 11.21.0
 ---------------
 
diff --git a/common b/common
@@ -1 +1 @@
-Subproject commit dc38305da0e7d454da202b1205bde37ac1dd0cb2
+Subproject commit cb612eb3d958ef9200421854725e426771474a63
diff --git a/docs/dev/design/flyout-redesign.rst b/docs/dev/design/flyout-redesign.rst
@@ -11,7 +11,7 @@ Flyout Redesign Design Document
 
 
 This document describes the design of a new "flyout API"
-to replace our existing :ref:`"footer_html" <api/v2:Undocumented resources and endpoints>` endpoint in APIv2.
+to replace our existing `footer_html` endpoint in APIv2.
 The Read the Docs theme uses this API to put an updated version selector
 with active versions into the lower left menu.
 On other themes, this appears as a floating menu in the lower right.
diff --git a/docs/user/advertising/advertising-details.rst b/docs/user/advertising/advertising-details.rst
@@ -83,9 +83,7 @@ We can place ads in:
 * a small footer fixed to the bottom of the viewport
 * on 404 pages (rare)
 
-We show no more than one ad per page so you will never see both
-a sidebar ad and a footer ad on the same page.
-
+We never show more than 1 ad on a page.
 
 Do Not Track Policy
 -------------------
diff --git a/docs/user/advertising/ethical-advertising.rst b/docs/user/advertising/ethical-advertising.rst
@@ -38,7 +38,7 @@ feel free to `shoot us an email <mailto:rev@readthedocs.org>`_.
 You can :ref:`opt out <advertising/ethical-advertising:Opting out>` of having paid ads on your projects,
 or seeing paid ads if you want.
 You will still see :ref:`community ads <advertising/ethical-advertising:Community Ads>`,
-which we run for free that promote community projects.
+which we run at no cost that promote community projects.
 
 Our worldview
 -------------
diff --git a/docs/user/commercial/subscriptions.rst b/docs/user/commercial/subscriptions.rst
@@ -60,7 +60,7 @@ Non-profit and academic organizations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Our community hosting,
-provided for free and open source projects,
+provided for open source projects,
 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.
diff --git a/docs/user/gsoc.rst b/docs/user/gsoc.rst
diff --git a/docs/user/guides/pdf-non-ascii-languages.rst b/docs/user/guides/pdf-non-ascii-languages.rst
@@ -6,7 +6,7 @@ relevant for instance for Japanese or Chinese.
 
 .. _LaTeX engines: http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-latex_engine
 
-To build your documentation in PDF format, you need to configure Sphinx properly in your project's ``conf.py``.
+To build your documentation in PDF, you need to configure Sphinx properly in your project's ``conf.py``.
 Read the Docs will execute the proper commands depending on these settings.
 There are `several settings that can be defined`_ (all the ones starting with ``latex_``),
 to modify Sphinx and Read the Docs behavior to make your documentation to build properly.
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -148,7 +148,7 @@ Open source and user focused
     Our company is bootstrapped and 100% user-focused,
     so our product gets better for our users instead of our investors.
     |org_brand| hosts documentation for over 100,000 large
-    and small open source projects for free.
+    and small open source projects at no cost.
     |com_brand| supports hundreds of organizations with product and internal documentation.
     Learn more about these differences on `our pricing page <https://about.readthedocs.com/pricing/>`_.
 
@@ -166,7 +166,7 @@ We have a few places for you to get started:
   Quick start for MkDocs and Docusaurus.
 
 :doc:`/examples`
-  Start your journey with an example project to hit the ground running.
+  Start your journey with an example project to learn how to use Read the Docs.
 
 Project setup and configuration
 -------------------------------
diff --git a/docs/vale b/docs/vale
@@ -0,0 +1 @@
+../common/vale/
diff --git a/docs/vale/RTD/sso.yaml b/docs/vale/RTD/sso.yaml
diff --git a/docs/vale/RTD/style.yml b/docs/vale/RTD/style.yml
diff --git a/tox.ini b/tox.ini
@@ -62,6 +62,8 @@ commands =
 description = run pre-commit to ensure the changes are valid against our lintings
 deps =
    pre-commit
+   docutils # Required for rst2html in vale
+
 commands =
     pre-commit run --all-files --show-diff-on-failure
 
