Repository navigation
Conversation
…ase candidate) Adds docs/sdk-v3 under /next/sdk/v3: v3 at a glance, a lifecycle map, the API reference by client namespace, error codes, warnings and findings, a 2.x to 3.x map and a page for AI agents. Pages are generated from the SDK source and spec by scripts/generate-sdk-v3-reference.sh, which also type-checks every sample. Generated from obol-sdk feat/sdk-v3-package at 080fa55 (3.0.0-rc.12). The 2.x SDK docs are unchanged; one sidebar link points to v3.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
The quality gate failed on reliability: two bugs in generate.mjs (a predicate passed straight to .filter(), and a conditional with identical branches). Both are fixed, along with the maintainability findings in the generator tooling. Generated pages are byte-identical. - Replace the regexes Sonar reports as super-linear with single-pass scanners (headingOf, isTableSeparator, replaceLinkTags, mapCodeSpans, attributedOperation, beforeParen) or anchored single-class patterns. - Format signatures and type declarations with prettier up front, so the page renderers are synchronous and no longer await in loops. - Split the page renderers into small helpers; remove nested ternaries, nested template literals, dead variables and void statements; use replaceAll, startsWith/endsWith, optional chaining and at(). - sdk-v3.css: drop two !important by outranking `.markdown li + li`. - Add .sonarcloud.properties excluding generated output (docs/sdk-v3/reference, docs/sdk-v3/_generated, sidebars-sdk-v3.mjs) and the example snippets (scripts/sdk-v3/examples) from analysis.
|
|
|
||
| /** The row of one field of an object parameter. */ | ||
| function paramFieldRow(p, f, file) { | ||
| const inherited = f.declaredIn && f.declaredIn !== p.type.replace(/<.*/, ''); |
This branch has not been deployed
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
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.
Adds docs/sdk-v3 under /next/sdk/v3: v3 at a glance, a lifecycle map, the API reference by client namespace, error codes, warnings and findings, a 2.x to 3.x map and a page for AI agents. Pages are generated from the SDK source and spec by scripts/generate-sdk-v3-reference.sh, which also type-checks every sample. Generated from obol-sdk feat/sdk-v3-package at 080fa55 (3.0.0-rc.12).
The 2.x SDK docs are unchanged; one sidebar link points to v3.
Wait for v3 to release before merging
Summary
Details
ticket: