Skip to content

env vars doc#638

Merged
DenhamPreen merged 3 commits intomainfrom
env-vars
Jun 20, 2025
Merged

env vars doc#638
DenhamPreen merged 3 commits intomainfrom
env-vars

Conversation

@DenhamPreen
Copy link
Contributor

@DenhamPreen DenhamPreen commented May 21, 2025

please merge if happy

Summary by CodeRabbit

  • Documentation
    • Updated configuration file guide to use a consistent ENVIO_ prefix for environment variables and improved example commands.
    • Added a new Environment Variables guide detailing best practices and usage for configuring the Envio indexer.
    • Included the new guide in the documentation sidebar for easier access.

@DenhamPreen DenhamPreen requested a review from moose-code May 21, 2025 06:44
@vercel
Copy link

vercel bot commented May 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
envio-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 20, 2025 7:22am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 21, 2025

Walkthrough

The documentation was updated to standardize the use of the ENVIO_ prefix for all environment variables in configuration examples and explanatory text. A new "Environment Variables" guide was added, detailing best practices and usage. The sidebar configuration was updated to include this new guide in the documentation navigation.

Changes

File(s) Change Summary
docs/HyperIndex/Guides/configuration-file.mdx Updated environment variable examples to use the ENVIO_ prefix; revised interpolation syntax; added a reference link to the new Environment Variables Guide.
docs/HyperIndex/Guides/environment-variables.md Added a new guide explaining environment variable usage, required prefix, best practices, and troubleshooting.
sidebarsHyperIndex.js Added the new "Environment Variables" guide to the sidebar under the "Guides" section.

Poem

In the docs, a prefix grew—
ENVIO_ leads the way, it's true!
Variables tidy, secrets kept tight,
With guides and links, we set it right.
Now the sidebar hops along,
To a guide where configs belong!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 5b47c8b and 0bd8fa4.

📒 Files selected for processing (1)
  • docs/HyperIndex/Guides/environment-variables.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/HyperIndex/Guides/environment-variables.md

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
docs/HyperIndex/Guides/environment-variables.md (1)

65-71: Normalize list numbering in Best Practices
All items are numbered 1. which can be confusing. Convert to proper incremental numbering or switch to a bulleted list for clarity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 59c9bf3 and 5b47c8b.

📒 Files selected for processing (3)
  • docs/HyperIndex/Guides/configuration-file.mdx (1 hunks)
  • docs/HyperIndex/Guides/environment-variables.md (1 hunks)
  • sidebarsHyperIndex.js (1 hunks)
🔇 Additional comments (2)
sidebarsHyperIndex.js (1)

56-56: Environment Variables guide added to sidebar
The new entry "Guides/environment-variables" correctly integrates the Environment Variables guide into the Guides category. Ensure the ordering of Guides remains logical (e.g., grouping related configuration topics together).

docs/HyperIndex/Guides/configuration-file.mdx (1)

183-187: Consistent ENVIO_ prefix applied to interpolation examples
All environment variable placeholders and the example invocation have been updated to use the ENVIO_ prefix (${ENVIO_CHAIN_ID}, ${ENVIO_GREETER_ADDRESS}, and ENVIO_CHAIN_ID=... ENVIO_GREETER_ADDRESS=...). This aligns with the new naming convention.

Also applies to: 192-193, 197-198


When using the Envio Hosted Service, you can configure environment variables through the Envio platform's dashboard. Remember that all variables must still be prefixed with `ENVIO_`.

For more information about environment variables in the hosted service, see the [Hosted Service documentation](../HyperIndex/hosted-service).
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Correct relative link to Hosted Service docs
The link target ../HyperIndex/hosted-service is incorrect from Guides/environment-variables.md. It should point to the Hosted_Service folder, e.g.:

[Hosted Service documentation](../Hosted_Service/hosted-service)
🤖 Prompt for AI Agents
In docs/HyperIndex/Guides/environment-variables.md at line 57, the relative link
to the Hosted Service documentation is incorrect. Update the link target from
../HyperIndex/hosted-service to ../Hosted_Service/hosted-service to correctly
point to the Hosted_Service folder.


## Configuration File

For use of environment variables in your configuration file, read the docs here: [Configuration File](../HyperIndex/configuration-file).
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Correct relative link to Configuration File guide
The link (../HyperIndex/configuration-file) is invalid from this location. It should reference the sibling guide in the same folder:

[Configuration File](./configuration-file)
🤖 Prompt for AI Agents
In docs/HyperIndex/Guides/environment-variables.md at line 61, the relative link
to the Configuration File guide is incorrect. Change the link from
(../HyperIndex/configuration-file) to (./configuration-file) to correctly
reference the sibling guide in the same folder.

// "Guides/subgraph-mPigration",
"Guides/testing",
"Guides/navigating-hasura",
"Guides/environment-variables",
Copy link
Member

Choose a reason for hiding this comment

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

Should it maybe in the advanced section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It could but I'm not sure it should

@DZakh
Copy link
Member

DZakh commented Jun 19, 2025

@DenhamPreen I don't know how it was lost. Happy to merge after the conflicts are resolved.

@DenhamPreen DenhamPreen merged commit 4d32d21 into main Jun 20, 2025
2 of 3 checks passed
@DenhamPreen DenhamPreen deleted the env-vars branch June 20, 2025 07:22
@DenhamPreen DenhamPreen mentioned this pull request Jul 29, 2025
@coderabbitai coderabbitai bot mentioned this pull request Aug 20, 2025
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