docs(docs): add experience.js migration workflow#384
Draft
Charles Hudson (phobetron) wants to merge 1 commit into
Draft
docs(docs): add experience.js migration workflow#384Charles Hudson (phobetron) wants to merge 1 commit into
Charles Hudson (phobetron) wants to merge 1 commit into
Conversation
Add the documentation pipeline for authoring experience.js to Optimization SDK Suite migration guides. This includes new local agent roles for legacy migration knowledge authoring and migration guide architecture, plus migration-aware source verification instructions for both Codex and Claude agent adapters. Add an internal experience.js migration knowledge file sourced from the adjacent experience.js checkout, and add a migration guide authoring recipe with dedicated migration blueprints for the supported migration paths: - Contentful model migration - Web SDK migration - React Web migration - Next.js migration path choice - Next.js App Router migration - Next.js Pages Router migration - Node, SSR, and ESR migration - Plugins and preview migration Add the public migration guide set and route it from the guides index in a dedicated experience.js migration section, separate from supplemental guides. Extend SDK knowledge for migration-relevant target behavior: - stateful flag-view tracking and manual trackFlagView usage - accepted and blocked event forwarding streams - preview audience, variant, and inline-variable overrides - Web, React Web, and Next.js migration-facing references for those behaviors Extend guide authoring validation so pnpm guides:check validates migration blueprints, including required frontmatter, template headings, route and section tables, fact-source links, source/guide targets, local links, anchors, and the migration guide section spine. Validation: - pnpm guides:check - pnpm knowledge:check - pnpm lint - targeted Prettier checks [[NT-3738](https://contentful.atlassian.net/browse/NT-3738)]
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
Adds the documentation workflow and guide set for migrating from
experience.jsto the Optimization SDK Suite.This PR introduces:
experience.jsknowledge capture and migration guide architecture.experience.jsmigration knowledge file.guides:checkcoverage for migration blueprints.What changed
Agent roles
Added new local agent adapters for both Codex and Claude:
experience-js-migration-knowledge-authormigration-guide-architectUpdated
guide-source-verifierso migration guides can verify:experience.jsclaims against migration knowledge and adjacent source for interface checks;Migration knowledge
Added internal migration knowledge for
experience.js, sourced from the adjacentexperience.jscheckout.The knowledge captures migration-relevant legacy behavior including:
@ninetailed/*packages to Optimization SDK targets;nt_*content-model assumptions;Authoring workflow
Added a migration guide recipe and dedicated migration blueprints for:
The migration recipe and blueprints now encode reusable review learnings, including:
Public guides
Added public migration guides for the same eight paths and updated
documentation/guides/README.mdwith a dedicatedexperience.js migration guidessection.The migration guide index now helps readers choose by:
SDK knowledge
Extended SDK knowledge with target behavior needed by the migration guides:
trackFlagView();eventStreampayloads;blockedEventStreamandonEventBlockedbehavior;Validation
Extended
scripts/validate-guide-authoring.tssopnpm guides:checknow validates migration blueprints as well as integration blueprints.Migration blueprint validation now checks:
Migration routeandSection plantable shape;sourceandguidetarget resolution;Review process
The guide set went through the intended staged workflow:
Review findings were resolved before final validation.
Validation
Ran:
All passed.
[NT-3738]