docs(config): add missing examples, fix structure and typos in configuration.md#440
docs(config): add missing examples, fix structure and typos in configuration.md#440
Conversation
- 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>
|
Warning Rate limit exceeded
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 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 configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
Addresses issue 1.3 from the docs audit: several configuration parameters listed in the summary table lacked
#### Examplesections, had inconsistent separators, a typo, and an incorrect section grouping that made non-query params appear under## Query Configurations.Changes
Missing
#### Examplesections added for:VKEY_MAX_ENTITY_COUNTCMD_INFOMAX_INFO_QUERIESIMPORT_FOLDERTEMP_FOLDERJS_HEAP_SIZEJS_STACK_SIZEIMPORT_FOLDER— Docker note added:LOAD CSVsilently fails in Docker containers when the CSV directory isn't volume-mounted. Added a prominent callout explaining the required-vflag and the error users will see (EMSG_FAILED_TO_LOAD_CSVfromsrc/errors/error_msgs.h).Structure fix:
Relocated
## Query Configurations/### Query Timeoutto the end of the page. Previously,EFFECTS_THRESHOLD,DELTA_MAX_PENDING_CHANGES,IMPORT_FOLDER,TEMP_FOLDER,DELAY_INDEXING,JS_HEAP_SIZE, andJS_STACK_SIZEwere incorrectly nested under a "Query Configurations" heading — they are module-level config parameters, not per-query settings.Other fixes:
---separators afterVKEY_MAX_ENTITY_COUNTandCMD_INFO(consistent with every other param on the page)It's→ItsinCMD_INFOdescriptionMAX_INFO_QUERIESrange descriptionJS_HEAP_SIZEandJS_STACK_SIZEsectionsTesting
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.