Skip to content

Commit

Permalink
docs: tidy up contributor docs (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
sgoudham committed Jul 20, 2023
1 parent 3d2ef9d commit c964ea1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 7 deletions.
7 changes: 4 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Feel free to leave this section empty if you don't have anything more to say.
- [ ] I have read and followed Catppuccin's [submission guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/userstyle-creation.md).
- [ ] I have made a new directory underneath `/styles/<name-of-website>` containing the contents of the [`/template`](https://github.com/catppuccin/userstyles/blob/main/template/) directory.
- [ ] I have ensured that the new directory is in **lower-kebab-case**.
- [ ] I have made sure to update the [`userstyles.yml`](https://github.com/catppuccin/userstyles/blob/main/src/userstyles.yml) file with information about the new directory.
- [ ] I have followed the template and kept the preprocessor as [LESS](https://lesscss.org/#overview).
- [ ] I have made sure to update the [`userstyles.yml`](https://github.com/catppuccin/userstyles/blob/main/src/userstyles.yml) file with information about the new userstyle.
- [ ] I have included the following files:
- `catppuccin.user.css` - all stylus code.
- `mocha.webp`, `macchiato.webp`, `frappe.webp` and `latte.webp` - individual screenshots of the themed website, in all 4 Catppuccin flavors.
- `catppuccin.user.css` - all the CSS for the userstyle, based on the template.
- `assets/mocha.webp`, `assets/macchiato.webp`, `assets/frappe.webp` and `assets/latte.webp` - individual screenshots of the themed website, in all 4 Catppuccin flavors.
- `catwalk.webp` - image of all individual screenshots stitched together, generated via [catwalk](https://github.com/catppuccin/toolbox#-catwalk).
8 changes: 6 additions & 2 deletions docs/browsers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Browsers

> **Note**:
> **Note** <br>
> If you see a popular browser that hasn't been added, please create a pull request to do so!
Find your browser version by following the instructions below:
Expand All @@ -23,4 +23,8 @@ Find your browser version by following the instructions below:
<td> Type <code>edge://version/</code>
</table>

TODO: Populate this document with common issues that are run into with these browsers
## Common Issues

> **Note** <br>
> If you are running into any compatibility issues with your browser, please consider opening
> a pull request and documenting your issue here!
7 changes: 5 additions & 2 deletions docs/userstyle-creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,15 @@ all people to request what they want without needing to learn what "Stylus" exac

### Creating Userstyles

Creating userstyles should be very simple if you follow the instructions given below:
To create a userstyle, follow the instructions listed below:

1. Fork this repository.
2. Create a new branch under the name `feat/<name-of-website>`, (e.g. `feat/nixos-search` instead of NixOS Search).
3. Create a new folder `styles/<name-of-website>`. The name must be `lower-kebab-case`.
- **If your website includes special characters, such as `.`, as part of its branding. Please replace this with `dotcom` instead.**
For example, `chess.com` would become `styles/chessdotcom`.
4. Copy the contents of the [`template`](../template/) folder into `styles/<name-of-website>`.
- **The template uses [LESS](https://lesscss.org/#overview) as the preprocessor for Stylus. Please do not change this as we will only accept userstyles based on the template.**
5. Edit the [`catppuccin.user.css`](../template/catppuccin.user.css) file and replace all the words wrapped with `<>` to fit the details of your port.
6. Edit the [`userstyle.yml`](../src/userstyles.yml) file and put in the details of your port. **More details given below.**
7. Create your image previews in the [`assets/`](../template/assets/) folder
Expand All @@ -38,7 +41,7 @@ Creating userstyles should be very simple if you follow the instructions given b

### `userstyles.yml`

Please note that the `README`'s for each port are auto-generated by scripts defined in [`src/generate`](../src/generate), along with many other parts of this repository.
Please note that the `README`s for each port are auto-generated by scripts defined in [`src/generate/`](../src/generate), along with many other parts of this repository.
This file, `userstyles.yml`, is responsible for holding the necessary data to auto-generate everything.

[`userstyles.schema.json`](../src/userstyles.schema.json) is the schema specification for this file. The fields in the following instructions are based on the schema:
Expand Down

0 comments on commit c964ea1

Please sign in to comment.