chore(docs): update docs/env.md file #277
Conversation
This is mostly a GPT curated file generated from config.ts.
📝 WalkthroughWalkthroughThis 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 Changes
Sequence Diagram(s)(No sequence diagram generated as the changes are primarily documentation-related) Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
ENVIRONMENT.md (1)
4-4: Add missing link reference forsrc/config.ts.The markdown reference
[src/config.ts]is missing its corresponding link definition.Add the following at the end of the file:
+[src/config.ts]: src/config.ts🧰 Tools
🪛 Markdownlint (0.37.0)
4-4: Missing link or image reference definition: "src/config.ts"
Reference links and images should use a label that is defined(MD052, reference-links-images)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
ENVIRONMENT.md(1 hunks)README.md(1 hunks)docker-compose.ao.yaml(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
ENVIRONMENT.md
4-4: Missing link or image reference definition: "src/config.ts"
Reference links and images should use a label that is defined
(MD052, reference-links-images)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: test (macos-latest)
- GitHub Check: test (ubuntu-latest)
🔇 Additional comments (3)
docker-compose.ao.yaml (1)
23-23: LGTM! Environment variables properly configured.The new environment variables are well-structured and follow the existing pattern in the file.
Also applies to: 39-39
README.md (1)
143-143: LGTM! Clear reference to environment variables documentation.The addition provides a helpful reference to the comprehensive environment variables documentation.
ENVIRONMENT.md (1)
1-193: LGTM! Comprehensive environment variables documentation.The documentation is well-structured, clearly categorized, and provides detailed information about each environment variable including descriptions and default values.
🧰 Tools
🪛 Markdownlint (0.37.0)
4-4: Missing link or image reference definition: "src/config.ts"
Reference links and images should use a label that is defined(MD052, reference-links-images)
Codecov ReportAll modified and coverable lines are covered by tests ✅
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 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/envs.md (4)
23-30: Fix missing table headers in File Configuration section.The table headers are missing in the File Configuration section. This inconsistency affects readability and documentation standards.
Add the table headers using this diff:
+| Variable | Description | Default | +| -------- | ----------- | ------- | | CHUNKS_DATA_PATH | Sets the location for chunked data | "./data/chunks" |
3-4: Fix broken link tosrc/config.ts.The link to
src/config.tsis broken. This affects the ability to navigate to the source configuration file.Update the link using proper markdown syntax:
-components. These can be found in the [`src/config.ts`][src/config.ts] file. +components. These can be found in the [`src/config.ts`](../src/config.ts) file.🧰 Tools
🪛 Markdownlint (0.37.0)
4-4: Missing link or image reference definition: "src/config.ts"
Reference links and images should use a label that is defined(MD052, reference-links-images)
17-17: Fix "Node.js" spelling.The official spelling of the framework is "Node.js", not "NodeJs".
-| NODE_JS_MAX_OLD_SPACE_SIZE | Sets the memory limit for NodeJs in Megabytes | 2048/8192 | +| NODE_JS_MAX_OLD_SPACE_SIZE | Sets the memory limit for Node.js in Megabytes | 2048/8192 |🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: The official spelling of this programming framework is “Node.js”.
Context: ...ACE_SIZE | Sets the memory limit for NodeJs in Megabytes | 2048/8192 | | ENABLE_...(NODE_JS)
98-102: Format bare URLs as proper markdown links.The URLs in the Arweave Nodes section should be properly formatted as markdown links for better documentation standards.
-| TRUSTED_NODE_URL | Trusted Arweave node URL | https://arweave.net | -| TRUSTED_GATEWAY_URL | Trusted gateway URL | https://arweave.net | -| TRUSTED_GATEWAYS_URLS | Trusted gateways URLs and weights | { 'https://arweave.net': 1 } | -| CHUNK_POST_URLS | Chunk POST URLs | https://arweave.net/chunk | +| TRUSTED_NODE_URL | Trusted Arweave node URL | `https://arweave.net` | +| TRUSTED_GATEWAY_URL | Trusted gateway URL | `https://arweave.net` | +| TRUSTED_GATEWAYS_URLS | Trusted gateways URLs and weights | `{ 'https://arweave.net': 1 }` | +| CHUNK_POST_URLS | Chunk POST URLs | `https://arweave.net/chunk` |🧰 Tools
🪛 Markdownlint (0.37.0)
98-98: null
Bare URL used(MD034, no-bare-urls)
99-99: null
Bare URL used(MD034, no-bare-urls)
100-100: null
Bare URL used(MD034, no-bare-urls)
101-101: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/envs.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/envs.md
[uncategorized] ~17-~17: The official spelling of this programming framework is “Node.js”.
Context: ...ACE_SIZE | Sets the memory limit for NodeJs in Megabytes | 2048/8192 | | ENABLE_...
(NODE_JS)
🪛 Markdownlint (0.37.0)
docs/envs.md
98-98: null
Bare URL used
(MD034, no-bare-urls)
99-99: null
Bare URL used
(MD034, no-bare-urls)
100-100: null
Bare URL used
(MD034, no-bare-urls)
101-101: null
Bare URL used
(MD034, no-bare-urls)
4-4: Missing link or image reference definition: "src/config.ts"
Reference links and images should use a label that is defined
(MD052, reference-links-images)
🔇 Additional comments (1)
docs/envs.md (1)
17-17: Clarify the default value format forNODE_JS_MAX_OLD_SPACE_SIZE.The default value "2048/8192" is ambiguous. It's unclear whether this represents a range, a conditional value, or different values for different environments.
Could you clarify:
- What do these two numbers represent?
- When is each value used?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: The official spelling of this programming framework is “Node.js”.
Context: ...ACE_SIZE | Sets the memory limit for NodeJs in Megabytes | 2048/8192 | | ENABLE_...(NODE_JS)
dtfiedler
changed the title
ENVIRONMENT.md file
This is mostly a GPT curated file generated from config.ts.