circleci · rosieyohannan · Nov 11, 2025 · Nov 7, 2025 · Nov 7, 2025 · Nov 7, 2025
@@ -2,6 +2,8 @@
 :page-noindex: true
 :experimental:
 
+pass:[<!-- vale off -->]
+
 [#styling-text]
 == Styling text
 
@@ -94,3 +96,5 @@ This is a longer admonition with an ordered list:
 . Step 2
 . Step 3
 ****
+
+pass:[<!-- vale on -->]
@@ -1,5 +1,6 @@
 = Headings
 
+pass:[<!-- vale off -->]
 * Write headings in a logical sequence. If you read section titles in order, the flow should present a good storyline for the doc.
 
 * Do not skip heading levels. For example, try not to jump from `h2` to `h4`, missing out `h3`.
@@ -21,3 +22,4 @@
 ** **Bad:** For more information, see the xref:guides:getting-started:hello-world.adoc["Hello world"] guide.
 
 * Do not use inline literal text in headings.
+pass:[<!-- vale on -->]
@@ -3,6 +3,8 @@
 :experimental:
 :page-layout: subsection
 
+pass:[<!-- vale off -->]
 This guide is a reference for contributors to CircleCI docs. Our style guide evolves so you will probably find older documentation does not meet the requirements set out here. Use this guide to help you write new docs, and when working on existing documentation it would be great if you can make edits to help keep everything consistent.
 
 For further information on markdown and AsciiDoc syntax refer to the https://github.github.com/gfm/[markdown documentation] and https://asciidoctor.org/docs/user-manual/[Asciidoctor User Guide].
+pass:[<!-- vale on -->]
@@ -1,5 +1,6 @@
 = Cross references and links
 
+pass:[<!-- vale off -->]
 This page covers how to create links and cross references in CircleCI docs.
 
 [#cross-references]
@@ -26,3 +27,4 @@ See the link:https://docs.antora.org/antora/latest/page/resource-id-coordinates/
 ----
 link:https://circleci.com[CircleCI]
 ----
+pass:[<!-- vale on -->]
@@ -1,6 +1,7 @@
 = Style and voice
 :experimental:
 
+pass:[<!-- vale off -->]
 == Talk confidently and directly
 Use an active voice, talk directly to the reader using simple, direct, clear and confident language. Using active voice helps us to keep instructions as short as possible, and is, in most cases, the quickest way to convey meaning to the reader
 
@@ -18,6 +19,8 @@ Assume technical competence but explain concepts clearly and simply. Some concep
 * Avoid contractions, for example "don't", "you're". They make the content harder for non-native english speakers to read.
 * Do not use time-sentitive language like, "new" or "soon" or "in preview" in main prose. These can get missed when changes are needed. If this language is needed it should be in a banner (admonition) that is clearly there to indicate the time-sensitive nature of the content.
 
+[.table-scroll]
+--
 [cols=2*, options="header"]
 |===
 | Avoid
@@ -38,6 +41,7 @@ Assume technical competence but explain concepts clearly and simply. Some concep
 | Guys
 | Folks, y’all, people, humans, teammates
 |===
+--
 
 == Talking about CircleCI
 * The CircleCI is referred to as the "web app".
@@ -70,3 +74,4 @@ Assume technical competence but explain concepts clearly and simply. Some concep
 ** Read the setup guide …
 ** Set up your account …
 * **Do use** open source, **not** opensource, or open-source
+pass:[<!-- vale on -->]
@@ -1,5 +1,6 @@
 = Using code samples
 
+pass:[<!-- vale off -->]
 * Provide code examples to help with clarity, and to help the reader reproduce the subject matter.
 
 * CircleCI config should always be tested as valid before adding it to docs.
@@ -52,4 +53,5 @@ workflows:
   my-workflow:
     jobs:
       - hello-job
-----
+----
+pass:[<!-- vale on -->]
@@ -2,6 +2,7 @@
 :page-description: Guidelines for using images in CircleCI documentation.
 :experimental:
 
+pass:[<!-- vale off -->]
 This page provides guidelines for using images in CircleCI documentation.
 
 == Guidelines for all images
@@ -109,4 +110,5 @@ sequenceDiagram
     participant Bob
     Alice->>Bob: Hello Bob, how are you?
     Bob-->>Alice: Great!
-....
+....
+pass:[<!-- vale on -->]
@@ -1,5 +1,6 @@
 = Using lists
 
+pass:[<!-- vale off -->]
 * To generate numbered steps (an ordered list) use the following syntax:
 +
 [source,adoc]
@@ -28,3 +29,4 @@
 * Capitalize the first word of each item in a list.
 
 * If the text in the bullet is a full sentence or completes the intro stem use a period at the end.
+pass:[<!-- vale on -->]
@@ -1,10 +1,14 @@
 = Using tables
 
+pass:[<!-- vale off -->]
 == Basic table syntax
 Use the following format for tables:
 
 [source,adoc]
 ----
+
+[.table-scroll]
+--
 [cols=4*, options="header"]
 |===
 | Key
@@ -17,10 +21,13 @@ Use the following format for tables:
 | String
 | Should currently be `2`
 |===
+--
 ----
 
 Looks like:
 
+[.table-scroll]
+--
 [cols=4*, options="header"]
 |===
 | Key
@@ -33,6 +40,7 @@ Looks like:
 | String
 | Should currently be `2`
 |===
+--
 
 == Extra wide tables
 
@@ -77,4 +85,5 @@ Looks like:
 
 == Advanced table options
 
-There are a lot of options for formatting tables, cell, rows, columns. For more information, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs]
+There are a lot of options for formatting tables, cell, rows, columns. For more information, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs]
+pass:[<!-- vale on -->]
@@ -3,6 +3,7 @@
 :page-description: A short page description goes here max 155 characters.
 :experimental:
 
+pass:[<!-- vale off -->]
 ////
 :page-platform: drives the platform badges that you see in the info bar under the page title.
 :page-description: is used for SEO and meta description. This should be a short description of the page content. Between 70 and 155 characters.
@@ -69,6 +70,8 @@ Break up large blocks of text where possible to help make it easier to consume.
 
 This section shows how to create a table. This example has one heading row and one regular row. The table has three columns, and the third column is twice as wide as the first two columns. THe table has a title.
 
+[.table-scroll]
+--
 .This is a table
 [cols="1,1,2"]
 |===
@@ -78,6 +81,7 @@ This section shows how to create a table. This example has one heading row and o
 |Text for row 1 column 2
 |Text for row 1 column 3
 |===
+--
 
 For a full description of the options available, including merging cells, and cell formatting, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs].
 
@@ -193,3 +197,4 @@ Place the answer here after the question.
 * xref:template-tutorial.adoc[Tutorial template]
 * xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
 * xref:guides:about-circleci:concepts.adoc[CircleCI concepts]
+pass:[<!-- vale on -->]
@@ -3,6 +3,7 @@
 :page-description: A short page description goes here max 155 characters.
 :experimental:
 
+pass:[<!-- vale off -->]
 ////
 Some notes on attributes:
 :page-platform: drives the platform badges that you see in the info bar under the page title.
@@ -66,6 +67,8 @@ Break up large blocks of text where possible to help make it easier to consume.
 
 This section shows how to create a table. This example has one heading row and one regular row. The table has three columns, and the third column is twice as wide as the first two columns. THe table has a title.
 
+[.table-scroll]
+--
 .This is a table
 [cols="1,1,2"]
 |===
@@ -75,6 +78,7 @@ This section shows how to create a table. This example has one heading row and o
 |Text for row 1 column 2
 |Text for row 1 column 3
 |===
+--
 
 For a full description of the options available, including merging cells, and cell formatting, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs].
 
@@ -188,3 +192,5 @@ End the guide with a conclusion section that summarizes what was covered.
 // Here you can inlude links to other pages in docs or the blog etc. where the reader should head next.
 * xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
 * xref:guides:about-circleci:concepts.adoc[CircleCI concepts]
+
+pass:[<!-- vale on -->]
@@ -3,6 +3,7 @@
 :page-description: A short page description goes here
 :experimental:
 
+pass:[<!-- vale off -->]
 ////
 Some notes on attributes
 
@@ -65,6 +66,8 @@ Break up large blocks of text where possible to help make it easier to consume.
 
 This is the syntax for creating a table. This example has one heading row and one normal row. The table has three columns
 
+[.table-scroll]
+--
 [cols=3*, options="header"]
 |===
 |Header text column 1
@@ -75,6 +78,7 @@ This is the syntax for creating a table. This example has one heading row and on
 |Text for row 1 column 2
 |Text for row 1 column 3
 |===
+--
 
 For a full description of the options available, including merging cells, and cell formatting, see the link:https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/[Asciidoctor docs].
 
@@ -150,3 +154,5 @@ End the tutoral with a conclusion section that summarizes what was covered.
 // Here you can inlude links to other pages in docs or the blog etc. where the reader should head next.
 * xref:guides:about-circleci:benefits-of-circleci.adoc[Benefits of CircleCI]
 * xref:guides:about-circleci:concepts.adoc[CircleCI concepts]
+
+pass:[<!-- vale on -->]
@@ -3,6 +3,7 @@
 :page-description: A page with all components for testing the new docs site.
 :experimental:
 
+pass:[<!-- vale off -->]
 [#introduction]
 == Introduction
 
@@ -61,6 +62,8 @@ include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
 
 ==== This is a table
 
+[.table-scroll]
+--
 [cols=3*, options="header"]
 |===
 |Header text column 1
@@ -75,6 +78,7 @@ include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
 |Text for row 2 column 2
 |Text for row 2 column 3
 |===
+--
 
 ==== This is a code block
 
@@ -112,3 +116,5 @@ workflows:
 *Thing two*:: Definition of thing two.
 
 *Thing three*:: Definition of thing three.
+
+pass:[<!-- vale on -->]
@@ -1,3 +1,5 @@
+[.table-scroll]
+--
 [cols=2*, options="header"]
 |===
 |Tool
@@ -16,3 +18,4 @@ a| 3.12.0 +
 a| 1.6.0 +
 1.5.0
 |===
+--
@@ -1,3 +1,5 @@
+[.table-scroll]
+--
 [cols=6*, options="header"]
 |===
 | Class  | vCPUs | RAM | Disk Size | Cloud | Server
@@ -30,5 +32,6 @@
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 |===
+--
 
 NOTE: **Using server?** Check with your systems administrator whether you have access to the Arm execution environment.
@@ -2,13 +2,15 @@
 ****
 *Arm on Docker* For credit and access information see the link:https://circleci.com/product/features/resource-classes/[Resource classes page]. Resource class access is dependent on your xref:guides:plans-pricing:plan-overview.adoc[Plan]
 
-To find out which CircleCI Docker convenience images support Arm resource classes, you can refer to link:https://hub.docker.com/u/cimg[Docker hub]:
+To find out which CircleCI Docker convenience images support Arm resource classes, you can refer to link:https://hub.docker.com/u/cimg[Docker Hub]:
 
 . Select the image (for example, `cimg/python`).
 . Select the **tags** tab.
 . View what is supported under **OS/ARCH** for the latest tags. For example, `cimg/python` has `linux/amd64` and `linux/arm64`, which means Arm **is** supported.
 ****
 
+[.table-scroll]
+--
 [cols=5*, options="header"]
 |===
 | Class | vCPUs | RAM | Cloud | Server
@@ -37,3 +39,4 @@ To find out which CircleCI Docker convenience images support Arm resource classe
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 | image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
 |===
+--
@@ -1,5 +1,7 @@
 NOTE: For credit and access information, see the link:https://circleci.com/product/features/resource-classes/[Resource classes page]. Resource class access is dependent on your xref:guides:plans-pricing:plan-overview.adoc[Plan].
 
+[.table-scroll]
+--
 [cols=5*, options="header"]
 |===
 | Class | vCPUs | RAM | Cloud | Server
@@ -46,3 +48,4 @@ NOTE: For credit and access information, see the link:https://circleci.com/produ
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 |===
+--
@@ -1,3 +1,5 @@
+[.table-scroll]
+--
 [cols="3,1,1,1,1,1,1,1,1", options="header"]
 |===
 | Class | vCPUs | RAM | GPUs | GPU model | GPU Memory (GiB) | Disk Size (GiB) | Cloud | Server
@@ -62,3 +64,4 @@
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 | image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
 |===
+--
@@ -1,3 +1,5 @@
+[.table-scroll]
+--
 [cols=9*, options="header"]
 |===
 | Class | vCPUs | RAM | GPUs | GPU model | GPU Memory (GiB) | Disk Size (GiB)| Cloud | Server
@@ -12,3 +14,4 @@
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 | image:guides:ROOT:icons/cancel.svg[cancel icon, role="no-border"]
 |===
+--
@@ -1,3 +1,5 @@
+[.table-scroll]
+--
 [cols=6*, options="header"]
 |===
 |Class | vCPUs | RAM | Disk Size | Cloud | Server
@@ -37,3 +39,4 @@
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 | image:guides:ROOT:icons/check.svg[check icon, role="no-border"]
 |===
+--