Conversation
Covers config precedence, JSON file format, NITRO_ env var mapping, Docker config mounting, conf.dump usage, hot reload, and S3 loading. Addresses TW-693 (partial).
Create docs/run-arbitrum-node/nitro/docker-and-cli-binaries.mdx covering Nitro Docker image variants, complete binary catalog extracted from the Nitro source tree, entrypoint usage, Docker Compose example, and port reference. Add sidebar entry under run-arbitrum-node/nitro section.
Document the three DA-related Nitro CLI binaries: anytrusttool (keygen, dumpkeyset, client, generatehash), anytrustserver, and daprovider. All flags, defaults, and output formats derived from Nitro source code.
Merge all content from the existing memory management page (allocators, cache config, GOMEMLIMIT calculation) and add new sections: validator tuning, metrics/monitoring, health checks, and sized example configurations (32 GB full, 128 GB archive, 16 GB validator).
Introduce scripts/generate-cli-reference.ts that reads structured flag data from scripts/data/nitro-cli-flags.json (634 flags across 23 namespaces) and generates docs/run-arbitrum-node/nitro/cli-flags-reference.mdx with collapsible namespace sections, type/default columns, and cross-links to curated guides. Add all 5 Nitro CLI guide pages to sidebars.js and the generate-cli-reference script entry to package.json.
Run Prettier on generated output before comparing with the committed file, since Prettier reformats table padding, asterisk escaping, and column widths in markdown tables.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced Mar 26, 2026
Curly braces in flag descriptions and defaults were being parsed as JSX expressions by MDX. Added escaping in the generation script and regenerated the output.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
run-arbitrum-node/nitro/covering the Nitro CLI configuration system, Docker images, DA tools, node tuning, and a complete flag referencescripts/generate-cli-reference.ts) that produces the exhaustive 634-flag reference from Helm chart dataNew pages
configuration-system.mdxdocker-and-cli-binaries.mdxda-tools-reference.mdxnode-tuning-and-monitoring.mdxcli-flags-reference.mdxMotivation
Addresses content gaps identified in the Inkeep analysis (450 undocumented questions). Primary Linear issue: TW-693 (Nitro CLI reference). Also partially addresses TW-692, TW-694, TW-695, TW-696, TW-697, TW-698.
Post-merge cleanup
After merging,
docs/run-arbitrum-node/nitro/05-nitro-memory-management.mdxshould be removed (its content is merged intonode-tuning-and-monitoring.mdx). This requires updating internal links first.Test plan
yarn buildpasses with all 5 new pagesyarn lint:markdownpassesyarn formatpassesyarn generate-cli-reference --checkpasses (generated output matches committed file)