Repository navigation
docs(v2): cookbook corrections (3/3) - #311
SohamRatnaparkhi wants to merge 9 commits into
Conversation
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
✅ Mintlify HygieneNo issues found. |
✅ OpenHack SummarySecurity review of docs(v2): cookbook corrections (3/3). 13 changed files; 0 findings at or above the low reporting threshold.
Confidence Score: 5/5No reportable security findings were detected in this scan. Security merge-readiness rubric: 1 = critical, 2 = high, 3 = medium, 4 = low, 5 = no reportable findings. This score reflects scan findings, not a guarantee of correctness or complete coverage. Files Needing Attention: None Important Files Changed
Last reviewed commit: 8f5d69e · View review on OpenHack
|
![openhack-agent[bot]](https://avatars.githubusercontent.com/in/2637932?s=60&v=4){kind=small}
Every cookbook was read line by line and its code checked against the backend, the TS SDK 2.1.7, and the Python SDK 2.1.5. The voice, structure and examples stay; wrong code, filler and invented claims go. Code fixes: - Queries and status checks now name the collection the data was written to. Several cookbooks searched or polled the default collection. - Memory curl examples use multipart with a JSON-stringified memories field instead of a JSON body. - upsert is the string "true" in TS, as the SDK types it. - TS reads camelCase chunk fields (sourceTitle, chunkContent, additionalMetadata); Python reads SDK attributes, not dict keys. - Filters use the equals and contains_any operators, and schema-backed filter keys are declared in database_metadata_schema. - Database readiness polls infra.ready_for_ingestion; indexing polls indexing_status instead of fixed sleeps. - Travel planner groups itinerary chunks by additional_metadata.category, since an item's type is not returned. - Recency examples send an event time, which recency_bias reads. Removed: invented ROI and latency claims, a fake "20 per request" API limit (now pacing advice), dead session code, and filler words. Refs PRO-2457 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review the current head, including the corrected cookbook examples. |
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review the latest head, including the final removal of repeated cookbook openings and unsupported claims. |
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please reassess the current head and the inline responses. Valid ACL, metadata-filter, indexing, and criteria issues are fixed and tested. Execution through the published SDK confirms the existing camelCase response reads. The implementation evidence also confirms object-valued nested metadata, equality filtering without an enable_match gate, and the 0.4 recency default. |
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review the current head dd0d50a. Both findings from the previous review are fixed: Glean UI search uses an authenticated backend callback, tenant search passes caller ACL and collection in the correct positions, and recruiter search insights are recomputed from accepted candidates. Runtime checks cover these paths, including permission denial and empty accepted results; the hosted validation and hygiene checks pass. Details are in the inline replies. |
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review current head dd4740f. This pass gives the cookbook index a quickstart prerequisite and replaces unexplained terminology in its descriptions. Tutorial code is unchanged. Local and hosted build validation, hygiene, and link checks pass. |
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review current head 8f5d69e. The Internal IT Support card now describes source titles alongside Slack search results, matching the tutorial output. This addresses the source-link finding; tutorial code is unchanged. |
This branch was successfully deployed
1 participant
Removes repeated openings, boilerplate, and unsupported product claims from all 12 V2 cookbooks and their index while retaining the walkthroughs and examples. Independent of #309 and #310.
Validation: Mintlify build and broken-link checks, MDX/frontmatter compilation, documentation hygiene, and Python/JSON example parsing passed. Extracted Gmail decoding, travel, preference-learning, recruiter lookup, interview-preparation, and ranking examples passed local checks with sample data. UI search dispatch, tenant permission/ACL/collection propagation, recruiter filtering and statistics, filter payloads, failure paths, and response conversion were checked through SDK 2.1.7 with mocked HTTP. External services were mocked; production integrations were not exercised.