Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Get started content structure #181

Open
morekid opened this issue Nov 4, 2024 · 2 comments
Open

Improve Get started content structure #181

morekid opened this issue Nov 4, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@morekid
Copy link
Contributor

morekid commented Nov 4, 2024

We guide people through configuring a few primitives in the Get started guides but we don't really take the time to explain them other than briefly in this intro paragraph.

Image

We should allow more space to explain what we're making people configure, eg:

This configures the following Arcjet rules:

  • Shield: protect your app from attacks
  • Bot proteciotn: prevent bots from accessing your app
  • Rate limit: ...,

Then follow up each rule specifically in the What next section, currently we only follow up on Bot protection:

Image

@morekid
Copy link
Contributor Author

morekid commented Nov 4, 2024

Consider explaining why we don't provide a test for shield, see: #179 (comment)

@Muhammad-Owais-Warsi
Copy link
Contributor

Muhammad-Owais-Warsi commented Dec 11, 2024

Hey @morekid , is it ok to explain each term as in this blog. Let me know if I misunderstood something. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants