chore(docs): update docs/env.md file

[dtfiedler]

This is mostly a GPT curated file generated from config.ts.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

This pull request focuses on enhancing documentation and configuration for the ar.io node, primarily updating the environment variable documentation. The changes include adding a reference to a new ENVIRONMENT.md file in the README, introducing new environment variables in the Docker Compose configuration, and significantly restructuring the environment variables documentation in docs/envs.md. The updates provide more comprehensive and organized information about configuration options, with a focus on improving clarity and accessibility.

Changes

File	Change Summary
README.md	Added reference to ENVIRONMENT.md in the Configuration section
docker-compose.ao.yaml	Added two new environment variables for ao-cu service: - UNIT_MODE (default: cu) - DISABLE_PROCESS_FILE_CHECKPOINT_CREATION (default: empty string)
docs/envs.md	- Restructured documentation with new section headers - Added new environment variables: * HEALTHCHECK_INTERVAL_SECONDS * HEALTHCHECK_TIMEOUT_SECONDS * HEALTHCHECK_FAILURE_THRESHOLD * HEALTHCHECK_SUCCESS_THRESHOLD * ENABLE_METRICS_ENDPOINT - Updated ADMIN_API_KEY description

Sequence Diagram(s)

(No sequence diagram generated as the changes are primarily documentation-related)

Possibly related PRs

• #255: Documentation of ADMIN_API_KEY_FILE environment variable
• #268: Introduction of new environment variables and configuration handling updates

Suggested reviewers

• djwhitt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 71.81%. Comparing base (2df0fb6) to head (76a1507). Report is 527 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #277   +/-   ##
========================================
  Coverage    71.81%   71.81%           
========================================
  Files           37       37           
  Lines         9298     9298           
  Branches       537      537           
========================================
  Hits          6677     6677           
  Misses        2617     2617           
  Partials         4        4           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[djwhitt]

@dtfiedler I'm holding off on merging this for now because I expect a bit more churn, but I'm curious what prompt(s) you used so I can replicate this alter when things settle down.