Merge pull request #9771 from circleci/DOCSS-1971-contributors

Contibutors guides updates

Author: rosieyohannan

.github/pull_request_template.md

@@ -1,17 +1,29 @@
+> [!NOTE]
+> You may find that there are errors for the `vale/lint` job that are unrelated to your change. Our prose linter checks the whole file when a change is made so if there are existing issues on the page they will be flagged. You can just leave these errors and the CircleCI docs team will address them for you. Our prose linter is advisory to help all contributors create content that conforms to our style guide. The linter feedback is advisory only and will not prevent changes from being published.
+
 # Description
 What did you change?
+<!-- Example: Added a new troubleshooting section for Docker executor authentication issues -->
 
 # Reasons
-Why did you make these changes?
+Why did you make these changes? What problem does this solve?
+<!-- Example: Users were reporting confusion about Docker authentication errors, and we had no documentation addressing this -->
+
+# Content checks
+Please follow our style when contributing to CircleCI docs. View our [style guide](https://circleci.com/docs/style/style-guide-overview) or check out our [CONTRIBUTING.md](../CONTRIBUTING.md) for more information.
 
-# Content Checklist
-Please follow our style when contributing to CircleCI docs. Our style guide is here: [https://circleci.com/docs/style/style-guide-overview](https://circleci.com/docs/style/style-guide-overview).
+**Preview your changes:**
+- To view the Vale linter results, select the `ci/circleci: lint` job at the bottom of your PR. You will be redirected to the `vale/lint` job output in CircleCI.
+- To preview your changes, select the `ci/circleci: build` job at the bottom of your PR, then select the Artifacts tab and select `index.html` to open a preview version of the docs site built for your latest commit.
 
-Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):
+Take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):
 
+**Content structure:**
 - [ ] Break up walls of text by adding paragraph breaks.
 - [ ] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
-- [ ] Keep the title between 20 and 70 characters.
 - [ ] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
-- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized).
 - [ ] Include relevant backlinks to other CircleCI docs/pages.
+
+**Formatting:**
+- [ ] Keep the title between 20 and 70 characters.
+- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized).

ARCHITECTURE.md

@@ -1,6 +1,6 @@
-# CircleCI Docs Static Site: Architecture
+# CircleCI docs site: Architecture
 
-This document provides an in-depth look at the architecture of the CircleCI Docs Static Site project.
+This document provides an in-depth look at the architecture of the CircleCI docs site project.
 
 ## Table of Contents
 - [Overview](#overview)
@@ -12,7 +12,7 @@ This document provides an in-depth look at the architecture of the CircleCI Docs
 
 ## Overview
 
-The CircleCI Docs Static Site is built using [Antora](https://antora.org/), a multi-repository documentation site generator. The project is structured as a collection of components, each represented by a directory in the `docs/` folder.
+The CircleCI docs site is built using [Antora](https://antora.org/), a multi-repository documentation site generator. The project is structured as a collection of components, each represented by a directory in the `docs/` folder.
 
 ### Key Architectural Principles