Skip to content

Commit

Permalink
docs(website): updated some links
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreaPontrandolfo committed Dec 3, 2023
1 parent 15f7746 commit ee22773
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion apps/docs-website/docs/core-philosophy/criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Just type `npx create-sheriff-config` in a CLI and you are good to go.

Easiness of use without compromises is the top priority of Sheriff. The basic principle behind many design decisions of Sheriff is to require as less inputs from the user as possible. <br />
You can think of Sheriff like `prettier` or `create-react-app`. It's a tool that comes battery-packed with optimal defaults. It removes configuration decisions from the equation, so you or your team can focus on developing the actual product.<br />
And if you don't like something, you can easily override it, and just as easily you can extend it. See: [configuration](../configuration.md).
And if you don't like something, you can easily override it, and just as easily you can extend it. See: [configuration](../configuration.mdx).

This config is particularly useful for big teams with developers of various skill levels.<br />
Sheriff was made to prevent all kind of mistakes and to align the team on the same playing field. It is battle-tested in real-world scenarios and shines especially in such.<br />
Expand Down
6 changes: 3 additions & 3 deletions apps/docs-website/docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ sidebar_position: 2

-**Batteries included**: Sheriff is a all-in-one solution. You don't need to install or configure separately anything else. Everything is included here
-**Seamless**: if you know ESLint, you know Sheriff
- 🔓 **No lock-in**: Sheriff has extended capabilities beyond being a simple eslint config, but it's **not** a framework. You can extend the `eslint.config.js` beyond Sheriff as much as you like, just like you normally would. Or you can disable any rule Sheriff comes with. Sheriff doesn't impose any limitation. See: [configuration](./configuration.md)
- 🔓 **No lock-in**: Sheriff has extended capabilities beyond being a simple eslint config, but it's **not** a framework. You can extend the `eslint.config.js` beyond Sheriff as much as you like, just like you normally would. Or you can disable any rule Sheriff comes with. Sheriff doesn't impose any limitation. See: [configuration](./configuration.mdx)
- 🏑 **Frictionless by design**: to setup Sheriff and take off, the only input required from the user is running the `create-sheriff-config` command. The command will automatically infer the details of your project and figure out the optimal Sheriff configuration by itself
-**Interoperability**: you can plop Sheriff in your project at any moment. `create-sheriff-config` will configure automatically everything for you and will warn you if you need to take any special precautions. Bottom line: it's never too late to install Sheriff
- 🏔 **Cutting-edge**: Sheriff is one of the first attempts in the wild to adhere to the new eslint configuration format, the `FlatConfig`. You can use Sheriff to easily and safely migrate your project to the new config format without effort. See: [migration guide](./migration-guide.md)
- 🏔 **Cutting-edge**: Sheriff is one of the first attempts in the wild to adhere to the new eslint configuration format, the `FlatConfig`. You can use Sheriff to easily and safely migrate your project to the new config format without effort. See: [migration guide](./migration-guide.mdx)
- 👊 **Sensible**: All of the rules that were hand-picked in Sheriff were chosen to counter some problematic real-world scenarios that can occur in production projects and to ensure maximum style consistency. No bloat here. See [criteria](./core-philosophy/criteria.md)
- 🗄️ **Configurable**: Sheriff is fully configurable with its own config object. See: [configuration](./configuration.md)
- 🗄️ **Configurable**: Sheriff is fully configurable with its own config object. See: [configuration](./configuration.mdx)
- 🐙 **Modular**: Sheriff has opt-in support for a [wide array of libraries](./techs.md)
- 🆙 **SemVer**: Sheriff [releases](https://github.com/AndreaPontrandolfo/sheriff/releases) follows [Semantic Versioning](https://semver.org/) with [Conventional Commits](https://www.conventionalcommits.org/) standards
2 changes: 1 addition & 1 deletion apps/docs-website/docs/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you are setting up Sheriff in an already established codebase, follow these s

1. Start by running the `create-sheriff-config` command and follow the advices that it prints in the console
1. Make sure that the only eslint config file present in any workspace is the `eslint.config.js`
1. If you want to keep your existing custom rules on-top of Sheriff, move them to the `eslint.config.js`, after the `sheriff` config, so they will override it. Refer to the [configuration instructions](./configuration.md)
1. If you want to keep your existing custom rules on-top of Sheriff, move them to the `eslint.config.js`, after the `sheriff` config, so they will override it. Refer to the [configuration instructions](./configuration.mdx)
1. Make sure to uninstall all the packages that Sheriff already incorporates out-of-the-box. [Here](./eslint-plugins.md) is the list

## Progressive adoption story
Expand Down
2 changes: 1 addition & 1 deletion apps/docs-website/docs/setup/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ your project. Then, let `create-sheriff-config` handle the whole setup for you a
or do it yourself manually. <br />
For greenfield projects, the below setup will be enough.
However, for already established codebases, you should also follow the instructions
for the [migration path](../migration-guide.md).
for the [migration path](../migration-guide.mdx).

<DocCardList />
4 changes: 2 additions & 2 deletions apps/docs-website/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ sidebar_position: 18
## `create-sheriff-config` fails when using yarn

Depending on the context and under specific conditions, `create-sheriff-config` may fail to install the dependencies when using `yarn`. <br />
In this case you can simply install them yourself. The `create-sheriff-config` process should spit out the correct command prompt for you to do so. If that doesn't happen, refer to the [manual setup instructions](./setup/manual-setup.md).
In this case you can simply install them yourself. The `create-sheriff-config` process should spit out the correct command prompt for you to do so. If that doesn't happen, refer to the [manual setup instructions](./setup/manual-setup.mdx).

Alternatively, consider switching package manager to [pnpm](https://pnpm.io/).

## My editor feels slow

Make sure to read the appropriate docs [here](./performance-considerations.md).
Make sure to read the appropriate docs [here](./performance-considerations.mdx).

0 comments on commit ee22773

Please sign in to comment.