mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 02:12:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Move documentation to docs.astral.sh/ruff (#7419)

Browse source 
## Summary

We're planning to move the documentation from
[https://beta.ruff.rs/docs](https://beta.ruff.rs/docs) to
[https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), for a few
reasons:

1. We want to remove the `beta` from the domain, as Ruff is no longer
considered beta software.
2. We want to migrate to a structure that could accommodate multiple
future tools living under one domain.

The docs are actually already live at
[https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), but later
today, I'll add a permanent redirect from the previous to the new
domain. **All existing links will continue to work, now and in
perpetuity.**

This PR contains the code changes necessary for the updated
documentation. As part of this effort, I moved the playground and
documentation from my personal Cloudflare account to our team Cloudflare
account (hence the new `--project-name` references). After merging, I'll
also update the secrets on this repo.
This commit is contained in:
Charlie Marsh 2023-09-15 22:49:42 -04:00 • committed by GitHub
parent cc9e84c144
commit 9b43162cc4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 58 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/faq.md
View file

@ -386,7 +386,9 @@ alone.
## What is preview?
Preview enables a collection of newer rules and fixes that are considered experimental or unstable. See the [preview documentation](https://beta.ruff.rs/docs/preview/) for more details; or, to see which rules are currently in preview, visit the [rules reference](https://beta.ruff.rs/docs/rules/).
Preview enables a collection of newer rules and fixes that are considered experimental or unstable.
See the [preview documentation](preview.md) for more details; or, to see which rules are currently
in preview, visit the [rules reference](rules.md).
## How can I tell what settings Ruff is using to check my code?

2
docs/preview.md
View file

@ -45,4 +45,4 @@ preview = true
Or, if you provided the `--preview` CLI flag.
To see which rules are currently in preview, visit the [rules reference](https://beta.ruff.rs/docs/rules/).
To see which rules are currently in preview, visit the [rules reference](rules.md).