Skip to content

docs(config): add missing examples, fix structure and typos in configuration.md#440

Open
gkorland wants to merge 2 commits intomainfrom
docs/config-missing-defaults-and-examples
Open

docs(config): add missing examples, fix structure and typos in configuration.md#440
gkorland wants to merge 2 commits intomainfrom
docs/config-missing-defaults-and-examples

Conversation

@gkorland
Copy link
Copy Markdown
Contributor

Summary

Addresses issue 1.3 from the docs audit: several configuration parameters listed in the summary table lacked #### Example sections, had inconsistent separators, a typo, and an incorrect section grouping that made non-query params appear under ## Query Configurations.

Changes

Missing #### Example sections added for:

  • VKEY_MAX_ENTITY_COUNT
  • CMD_INFO
  • MAX_INFO_QUERIES
  • IMPORT_FOLDER
  • TEMP_FOLDER
  • JS_HEAP_SIZE
  • JS_STACK_SIZE

IMPORT_FOLDER — Docker note added:
LOAD CSV silently fails in Docker containers when the CSV directory isn't volume-mounted. Added a prominent callout explaining the required -v flag and the error users will see (EMSG_FAILED_TO_LOAD_CSV from src/errors/error_msgs.h).

Structure fix:
Relocated ## Query Configurations / ### Query Timeout to the end of the page. Previously, EFFECTS_THRESHOLD, DELTA_MAX_PENDING_CHANGES, IMPORT_FOLDER, TEMP_FOLDER, DELAY_INDEXING, JS_HEAP_SIZE, and JS_STACK_SIZE were incorrectly nested under a "Query Configurations" heading — they are module-level config parameters, not per-query settings.

Other fixes:

  • Added missing --- separators after VKEY_MAX_ENTITY_COUNT and CMD_INFO (consistent with every other param on the page)
  • Fixed typo: It'sIts in CMD_INFO description
  • Fixed missing trailing period in MAX_INFO_QUERIES range description
  • Stripped trailing whitespace from JS_HEAP_SIZE and JS_STACK_SIZE sections

Testing

Documentation-only change. Verified heading structure with grep -n "^##\|^###\|^####".

Memory / Performance Impact

N/A

Related Issues

Audit finding 1.3 — Configuration table omits defaults and examples for ~9 fields.

- Add `#### Example` sections to VKEY_MAX_ENTITY_COUNT, CMD_INFO,
  MAX_INFO_QUERIES, IMPORT_FOLDER, TEMP_FOLDER, JS_HEAP_SIZE,
  JS_STACK_SIZE (were previously undocumented)
- Add `---` horizontal-rule separators after VKEY_MAX_ENTITY_COUNT
  and CMD_INFO for consistency with the rest of the page
- Fix typo: "It's" → "Its" in CMD_INFO description
- Fix missing trailing period in MAX_INFO_QUERIES range description
- Add Docker volume-mount note to IMPORT_FOLDER explaining that
  LOAD CSV silently fails without the mount (src: EMSG_FAILED_TO_LOAD_CSV)
- Relocate `## Query Configurations` / `### Query Timeout` section to
  the end of the page so EFFECTS_THRESHOLD, DELTA_MAX_PENDING_CHANGES,
  IMPORT_FOLDER, TEMP_FOLDER, DELAY_INDEXING, JS_HEAP_SIZE, JS_STACK_SIZE
  are no longer incorrectly nested under a "Query Configurations" heading
- Strip trailing whitespace from JS_HEAP_SIZE and JS_STACK_SIZE sections

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

Warning

Rate limit exceeded

@gkorland has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 5 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 12 minutes and 5 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 22437880-111f-47ce-b507-8a8828097721

📥 Commits

Reviewing files that changed from the base of the PR and between 70d1bd4 and a2a620b.

📒 Files selected for processing (1)
  • getting-started/configuration.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/config-missing-defaults-and-examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant