Skip to content

Commit

Permalink
docs: link file references in README via relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
not-my-profile committed Sep 1, 2024
1 parent f1fa083 commit 5c6d2ae
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,19 @@ You will be now be able to see the rendered site if you navigate to

# Docs Styling

You can find all of the styling assets for the Concourse website and documentation under the [`css/`](https://github.com/concourse/docs/tree/master/css) folder.
You can find all of the styling assets for the Concourse website and documentation under the [`css/`](./css) folder.

If you are planning to make changes to the site, [`css/booklit.css`](https://github.com/concourse/docs/blob/master/css/booklit.css) is usually a good place to start.
If you are planning to make changes to the site, [`css/booklit.css`](./css/booklit.css) is usually a good place to start.

# Content Layout

All of the website content can be found under the [`lit/`](https://github.com/concourse/docs/tree/master/lit) folder of this repository.
All of the website content can be found under the [`lit/`](./lit) folder of this repository.

The content layout for the site is qute simple, and for the most part self-explanatory. If you want to change a specific page on the website you can usually jump straight to it by looking for the `.lit` version of the page. For example you can make changes to https://concourse-ci.org/fly.html by editing `lit/fly.lit`.

* **`html/docs-header.tmpl`** L1 navigation header for the Concourse website and docs.
* **`lit/index.lit`** The Concourse Homepage
* **`lit/docs/`** This is where you'll find most of the documentation listed under https://concourse-ci.org/docs.html
* [`html/docs-header.tmpl`](./html/docs-header.tmpl) L1 navigation header for the Concourse website and docs.
* [`lit/index.lit`](./lit/index.lit) The Concourse Homepage
* [`lit/docs/`](./lit/docs/) This is where you'll find most of the documentation listed under https://concourse-ci.org/docs.html

The Resource Types live in a separate repository: [concourse/resource-types](https://github.com/concourse/resource-types).

Expand Down

0 comments on commit 5c6d2ae

Please sign in to comment.