Title: docs: correct two statements that contradict what they describe by waleedlatif1 · Pull Request #7092 · simstudioai/sim · GitHub
Open Graph Title: docs: correct two statements that contradict what they describe by waleedlatif1 · Pull Request #7092 · simstudioai/sim
X Title: docs: correct two statements that contradict what they describe by waleedlatif1 · Pull Request #7092 · simstudioai/sim
Description: Follow-up to the 26 unresolved cubic threads on the v0.8.12 release PR (#7090). None of the 26 are on code the recent de-slop work touched (#7060, #7062, #7063, #7082). I evaluated all of them by content rather than by path, since a finding can be relevant without landing on a changed line. Two are the same defect class that work was already correcting — documentation asserting something the code does not do — so they're fixed here. Two more looked like that class and turned out not to be; reasoning below so they aren't re-raised. Fixed 1. v2/knowledge/[knowledgeBaseId]/documents/route.ts — JSDoc contradicts the code and its own inline comment The JSDoc said workspaceId "is dropped for the same reason as on the sibling chunk list." The sibling genuinely drops it — its query type doesn't even carry the field. This list keeps it, and an inline comment five lines below the binding says so explicitly, with the reason: dropping it changes the cursor fingerprint, so every cursor minted before the change would be refused with a message telling the caller they altered a filter they never sent. Reworded to state the retention and defer to that note. The reasoning about why it's asserted scope rather than a filter was correct and is kept. 2. .agents/skills/v2-api-conventions/SKILL.md — stale hard-coded count "Fifteen lists take the pair." Parsing CURSOR_BINDINGS in contracts/v2/__tests__/list-pagination.test.ts gives 19 of 27 paged lists binding both sortBy and sortOrder. cubic's deeper point is the right one: a hard-coded count drifts every time a list gains sorting, which is exactly how this went stale. Now points at the test as the authoritative set instead of restating a number. Evaluated and declined docs/en/cli/files.mdx — --recursive "no longer lists any spellings" — false positive at the layer proposed. The sentence traces to .describe() on contracts/v2/files.ts:341, where the param is z.stringbool({ case: 'sensitive' }) carrying .meta({ enum: [...V2_TRUE_VALUES, ...V2_FALSE_VALUES] }) — 12 published, case-sensitive spellings. The sentence is true for the HTTP param. What's actually happening is the CLI doc renderer flattens a stringbool to a bare --recursive flag and drops the enum, so the sentence references a list the CLI table doesn't print. Deleting a true sentence from the shared contract would degrade the API reference to patch a renderer gap. If anything, the fix belongs in generate-cli-docs.ts. docs/en/cli/credentials.mdx — "Credential to update or disconnect." on delete — real imprecision, disproportionate fix. It comes from v2CredentialParamsSchema, a single .describe() deliberately shared by both the update and delete contracts. Splitting it means a second schema plus regenerating a 13k-line generated v2-api.ts and its mdx, for a P3 where the current wording is imprecise rather than wrong. Not ours The remaining 22 are unrelated to this work — v1 admin billing upsert, the Microsoft Word lost-update races, v2 pagination/presenter/HEAD findings, chat error-policy disclosure, the webhook Slack fan-out ordering, cron lease renewal, settings/navigation.ts hardcoding customBlocks: true, and the docs/de nav entries. Several are P1/P2 and worth someone's attention — particularly the settings/navigation.ts one, which describes a nav-vs-server disagreement the surrounding doc comment says the table exists to prevent. One note on adjacency: #7063 removed a stale vi.mock('@/app/api/webhooks/utils', ...) from the webhook trigger route test. I re-verified that module still doesn't exist, so the mock was inert and no coverage was lost. Separately, validateSlackSignature (lib/webhooks/providers/slack.ts:465) has zero test coverage — pre-existing, not caused by that removal, but worth recording. Verification bun run type-check clean, all 33 audits pass, 159 tests across list-pagination and app/api/v2/knowledge green. Both changes are comment/markdown only — no behavior change.
Open Graph Description: Follow-up to the 26 unresolved cubic threads on the v0.8.12 release PR (#7090). None of the 26 are on code the recent de-slop work touched (#7060, #7062, #7063, #7082). I evaluated all of them by c...
X Description: Follow-up to the 26 unresolved cubic threads on the v0.8.12 release PR (#7090). None of the 26 are on code the recent de-slop work touched (#7060, #7062, #7063, #7082). I evaluated all of them by c...
Opengraph URL: https://github.com/simstudioai/sim/pull/7092
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:57814713-eb9e-2460-9f7e-0689b7a5087d |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 8950:858A:BA5C61:107C0B6:6AFB5DDD |
| html-safe-nonce | a4ef08327223d9953261e5f70e165b2c9554573ccaa8f9d5314f114f3124869d |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4OTUwOjg1OEE6QkE1QzYxOjEwN0MwQjY6NkFGQjVEREQiLCJ2aXNpdG9yX2lkIjoiNTg2NDY4NDQzMzIzOTEzNzc1NyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 0ec0f6f49076bc871dc126882a86fafd4b30839401d0cdf1c6c12e55046144df |
| hovercard-subject-tag | pull_request:4363384378 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/simstudioai/sim/pull/7092/files |
| twitter:image | https://avatars.githubusercontent.com/u/40672544?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/40672544?s=400&v=4 |
| og:image:alt | Follow-up to the 26 unresolved cubic threads on the v0.8.12 release PR (#7090). None of the 26 are on code the recent de-slop work touched (#7060, #7062, #7063, #7082). I evaluated all of them by c... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | ea33d13c96d0ff66bd8fa906b193d2213536b78cb06b0c50a4632c58b1418f94 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/simstudioai/sim git https://github.com/simstudioai/sim.git |
| octolytics-dimension-user_id | 199344406 |
| octolytics-dimension-user_login | simstudioai |
| octolytics-dimension-repository_id | 912559512 |
| octolytics-dimension-repository_nwo | simstudioai/sim |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 912559512 |
| octolytics-dimension-repository_network_root_nwo | simstudioai/sim |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 59ef97164c52cf59bd10558ddec9c4f482763988 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width