Skip to content

docs: add docs on env variables#716

Merged
davidmytton merged 17 commits intomainfrom
wooorm/concept-env-variables
Dec 11, 2025
Merged

docs: add docs on env variables#716
davidmytton merged 17 commits intomainfrom
wooorm/concept-env-variables

Conversation

@wooorm-arcjet
Copy link
Copy Markdown
Contributor

Related-to: GH-704.
Related-to: ENG-127.

@wooorm-arcjet wooorm-arcjet requested a review from qw-in December 5, 2025 13:35
@wooorm-arcjet wooorm-arcjet requested a review from a team as a code owner December 5, 2025 13:35
@vercel
Copy link
Copy Markdown

vercel bot commented Dec 5, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
arcjet-docs Ready Ready Preview Comment Dec 11, 2025 2:56pm

Copy link
Copy Markdown
Contributor

@davidmytton davidmytton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to document these! Some suggestions for improving the PR.

Copy link
Copy Markdown
Member

@qw-in qw-in left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple comments between meetings


const aj = arcjet({
// Get your site key from https://app.arcjet.com
// Your Arcjet Cloud API key <https://docs.arcjet.com/concepts/environment#arcjet-key>.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Your Arcjet Cloud API key <https://docs.arcjet.com/concepts/environment#arcjet-key>.
// Your Arcjet key <https://docs.arcjet.com/concepts/environment#arcjet-key>.

Copy link
Copy Markdown
Member

@qw-in qw-in left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple of nit-y comments but overall think this is a great change with lots of good and helpful information! Thanks

(#717 went in so I expect those tests may fail against this branch. Good test of how much friction/pain vs value the tests add tho)

Copy link
Copy Markdown
Contributor

@davidmytton davidmytton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've moved the platform vars into their own section and also put this into the advanced section under the sidebar. We might want to reorganize this later,but I'd like to have more sections in Concepts. We can do that later.

Copy link
Copy Markdown
Contributor Author

@wooorm-arcjet wooorm-arcjet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Co-authored-by: Titus <titus@arcjet.com>
@davidmytton davidmytton merged commit cbc6ae6 into main Dec 11, 2025
5 checks passed
@davidmytton davidmytton deleted the wooorm/concept-env-variables branch December 11, 2025 14:56
@wooorm-arcjet
Copy link
Copy Markdown
Contributor Author

yay! Thanks all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants