Repository navigation
Conversation
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.
Summary
Populate the SDK preview with generated v1 and v2 documentation for Node, Browser, React and Vue, replacing the earlier React-only samples.
SDK READMEs and source comments in
reflagcom/javascriptremain the source of truth. This repository holds generated copies, navigation and preview configuration—not independently maintained SDK API docs.SUMMARY.mdnavigation.previews/sdk-versioningproject, retaining the same preview identity keys..gitbook.yamlfallbacks at both project locations point to the actual generated v2 content, rather than the maintainer README/empty prototype..gitattributesfor review.Start at
previews/sdk-versioning/README.md.Source versions
b4fe5b3d9386b87c6546175c323862d9878e14309f3a0ae027e386747a2d4cf7683a68dcab70b355The v1 checkout is Node's published tag; the other three package trees are identical to their published tags at
70b7fbe7e65e95e7bce5ccad64400b0c3e06f63c. V2 is an unreleased source candidate, not a packed/deployed acceptance claim. Native/OpenFeature/Management and the separate local CLI 2 work are not included in this coordinated selector.The importer applies only presentation/link fixes: version/source banners, major-pinned install commands, canonical README routing (avoiding TypeDoc's
_media/README.mdcollision), property-anchor normalization and trailing whitespace in generated code blocks. API text originates in the SDK repository. Landing/navigation files are not generated or overwritten by it.GitBook preview and remaining configuration
The generated v2 content is now visibly rendered at:
https://docs.reflag.com/~/revisions/WpbznaqM0NJHyEE54aa5/
That PR preview currently renders as a single space; no native version picker is visible. A space-level Git Sync connection reads
.gitbook.yaml, not a site-wide structure. Both v1/v2 content roots and native mappings are ready in the branch, but exposing them together requires site-wide Git Sync/content mapping or GitBook-configured variants. This PR does not silently replace that with Markdown tabs or duplicate version navigation.Read-only inspection of the existing live Reflag space still reported
main/individual-space sync. No connection, branch, sync direction, site structure, default or publication setting was changed. Do not infer site-settings isolation from a successful content PR preview.Scope / do not merge as production migration
sdk-preview-*keys are NOT replacements for production identities.README.md,SUMMARY.md, SDK include and generatedsdk/tree remain unchanged.Verification
yarn exec bash ./docs.shbecause that published script declares/bin/shbut contains[[.--checkreproduces both generated variants from the exact source checkouts.yarn test: both mappings validated against GitBook's published schema, generated provenance, complete navigation, aligned SDK paths, local pages/assets/anchors, and 14 passing tests/negative controls.any/wrapper guards. These are retained test fixtures, not a claim that every partial example in every generated reference was compiled.git diff --checkpass.Read-only CI: SUCCESS — https://github.com/reflagcom/docs/actions/runs/42226618831, including independent source rebuilds, generated-output comparisons and all six smoke examples.