Skip to content

[Unticketed] Correct a recent incorrect detail in docs#9022

Open
chouinar wants to merge 2 commits intomainfrom
chouinar/fix-docs-to-be-right
Open

[Unticketed] Correct a recent incorrect detail in docs#9022
chouinar wants to merge 2 commits intomainfrom
chouinar/fix-docs-to-be-right

Conversation

@chouinar
Copy link
Collaborator

Summary

Changes proposed

  • Fixes an incorrect bit of guidance in the API dics

Context for reviewers

You can't add these values to the override file because if you do, the API service won't work right. Instead we need the values set in your shell.

Validation steps

This is my actually local dev setup.

@chouinar chouinar requested a review from mdragon March 12, 2026 19:55
mdragon
mdragon previously approved these changes Mar 12, 2026
Copy link
Collaborator

@mdragon mdragon left a comment

Choose a reason for hiding this comment

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

Added a suggested change for referencing it could also be put in .bashrc or .zshrc

5. Certain environment variables require different paths when running outside of Docker.
You can handle this by setting these into your `override.env` file.
You can handle this by setting these environment variables yourself via a means other
than our .env files. One approach is to have an `.envrc` in the api directory that works with [direnv](https://direnv.net/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
than our .env files. One approach is to have an `.envrc` in the api directory that works with [direnv](https://direnv.net/)
than our .env files. One approach is to have an `.envrc` in the api directory that works with [direnv](https://direnv.net/) or set these in your `.bashrc` or `.zshrc`

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Reworded it a bit as it was a little clunky - mentioned those shell files before my alternative.

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.

2 participants