diff --git a/contribute/contribute-guide.md b/contribute/contribute-guide.md index 53b47da245..3f3f7cd941 100644 --- a/contribute/contribute-guide.md +++ b/contribute/contribute-guide.md @@ -27,10 +27,10 @@ There are two ways to contribute a pull request to the docs repository: Here’s a list of some of the important files: -- `/_data/toc.yaml` defines the left-hand navigation for the docs -- `/js/docs.js` defines most of the docs-specific JS such as the table of contents (ToC) generation and menu syncing -- `/css/style.scss` defines the docs-specific style rules -- `/_layouts/docs.html` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content +- `/_data/toc.yaml` defines the left-hand navigation for the docs. +- `/js/docs.js` defines most of the docs-specific JS such as the table of contents (ToC) generation and menu syncing. +- `/css/style.scss` defines the docs-specific style rules. +- `/_layouts/docs.html` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content. ### Files not edited here @@ -71,7 +71,7 @@ git clone {{ site.repo }}.git cd docs ``` -Then, build and run the documentation using [Docker Compose](../compose/index.md) +Then, build and run the documentation using [Docker Compose](../compose/index.md): ```bash docker compose up -d --build diff --git a/contribute/overview.md b/contribute/overview.md index eebbaa579c..e634eeacc2 100644 --- a/contribute/overview.md +++ b/contribute/overview.md @@ -76,7 +76,7 @@ as possible for you to work in this repository. The following sections guide you We also provide: -- A section of useful components you can add to your documentation. For components and controls, we use [Bootstrap](https://getbootstrap.com) +- A section of useful components you can add to your documentation. For components and controls, we use [Bootstrap](https://getbootstrap.com). - Information on Docker's [tone and voice](style/voice-tone.md). - A [writing checklist](checklist.md) to help you when you're contributing to Docker's documentation. - A command-line tool called vale to check the style and [help you find errors in your writing](contribute-guide.md#test-the-docs-locally). diff --git a/contribute/style/formatting.md b/contribute/style/formatting.md index 0371d04617..0b4123f6bd 100644 --- a/contribute/style/formatting.md +++ b/contribute/style/formatting.md @@ -25,7 +25,7 @@ Page titles should be action orientated. For example: ### Best practice: -- Make sure the title of your page and the TOC entry matches +- Make sure the title of your page and the TOC entry matches. - If you want to use a ‘:’ in a page title in the table of contents (_toc.yaml), you must wrap the entire title in “” to avoid breaking the build. ## Images