Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Ehrenhofer committed Feb 19, 2024
1 parent 360f02d commit da7cf88
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,34 @@ The goal is to educate and onboard power users faster.

## Contributing

You can contribute in the markdown format by opening a pull request.
Contributing is easy and much appreciated! You can contribute in the markdown format by opening a pull request.

Start by interacting with the `/docs` folder. The documentation is organized into various folders. Each of these folders contain markdown files.

Each folder needs a markdown file in it with the same name, acting as the parent. Children markdown files can be added to the folder. Please follow another example folder for the correct header content or follow the [Just the Docs documentation](https://just-the-docs.com/).

You will need to make a new branch to propose changes with a pull request.

If you do not know how to make a pull request, please create a GitHub issue with the page content you would like to add or modify, and someone will help you out with the changes.

## Images

Images should be placed under a folder in `/images` using the same folder name for the relevant markdown file in `/docs`.

When linking images, follow a format like this:

`[![Image name](/images/image.jpg){:width="32%"}](/images/image.jpg)`

This will format the image to 1/3 of the width of the screen, and it will allow a user to click on the image to get a full-screen view. This makes sense for some vertical images.

In select circumstances (such as short, wide images), it's better to make the image full-width. To do this, delete `{:width="32%"}` from the formatting above.

Please use `avif`, `webp`, or `svg` images instead of `jpg` or `png` images. `webp` and `avif` are supported by all modern browsers.

## Videos

Videos should have an accompanying image, and the link should go to the external video. For example:

`[![Image name](https://img.youtube.com/vi/<insert-youtube-video-id-here>/maxresdefault.jpg){:width="100%"}](https://youtube.com/watch?v=<insert-youtube-video-id-here>)`

At the time of writing, `maxresdefault.jpg` returns a 1280x720 image.
2 changes: 2 additions & 0 deletions docs/infrastructure/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
title: Infrastructure
has_children: true
---

# Infrastructure

0 comments on commit da7cf88

Please sign in to comment.