Skip to content

Commit

Permalink
Merge pull request #2036 from OctopusDeploy/TeganAli-patch-1
Browse files Browse the repository at this point in the history
Update README.md with links to new style guide
  • Loading branch information
TeganAli authored Oct 11, 2023
2 parents c585d71 + d2b34db commit 7722b80
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@ This repository contains the documentation for [Octopus Deploy](https://octopus.

Contributions to help improve this documentation are welcome, however, you must sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs) before we can accept your contribution.

See the [Octopus style guide](https://style.octopus.com) for information including:
See the [Octopus style guide](https://www.octopus.design/932c0f1a9/p/26f741-writing) for information including:

* [Markdown quick reference](https://style.octopus.com/markdown)
* [Capitalization](https://style.octopus.com/capitalization)
* [Working with images](https://style.octopus.com/images)
* [Predefined snippets to include in your text](https://style.octopus.com/octopus-snippets)
* [Markdown quick reference](https://www.octopus.design/932c0f1a9/p/074e30-markdown-reference)
* [Capitalization](https://www.octopus.design/932c0f1a9/p/457bc4-grammar-rules/t/03e016)
* [Working with images](https://www.octopus.design/932c0f1a9/p/5061d7-working-with-images)

## How to contribute a change to the docs

Expand All @@ -27,4 +26,4 @@ Before merging to `main` it's possible you'd like to see your changes in a previ
3. Run `pnpm dev` to run a local preview of the site
4. Open `localhost:3000` to view the site, the first page load usually takes a little time

You can generate a static copy of the site using `pnpm build` and run it in a browser with `pnpm preview`.
You can generate a static copy of the site using `pnpm build` and run it in a browser with `pnpm preview`.

0 comments on commit 7722b80

Please sign in to comment.