Skip to content

Commit

Permalink
wip: adds links to style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgilman committed Oct 26, 2023
1 parent ab207db commit f702a44
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ It's critical to understand what those tools are and how they interact together

The quickest way to get started learning is by going through the [onboarding process](./onboarding/index.md).
For more in-depth documentation, please review the [reference section](./reference/index.md).
Before contributing to an `Earthfile`, please review the [style guide](./style.md).
2 changes: 1 addition & 1 deletion docs/src/onboarding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ is ready to be tested and shipped.

## Getting Started

Before creating and/or modifying an `Earthfile`, it's imperative to review the style guide.
Before creating and/or modifying an `Earthfile`, it's imperative to review the [style guide](../style.md).
Due to the relative flexibility of Earthly, it's possible to structure an `Earthfile` in dozens of valid ways.
To provide consistency across our projects, we have implemented a style guide which brings a level of standardization to
`Earthfile`s.
Expand Down

0 comments on commit f702a44

Please sign in to comment.