Skip to content

DEV-2187 Correct Vue runtime SFC loading documentation - #315

Draft
tonytlwu wants to merge 1 commit into
masterfrom
feature/DEV-2161-vue-runtime-docs
Draft

tonytlwu wants to merge 1 commit into
masterfrom
feature/DEV-2161-vue-runtime-docs

Conversation

@tonytlwu

@tonytlwu tonytlwu commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Product areas affected

Developer documentation: V3 Vue and framework overview.

What does this PR do?

Corrects the false external SFC-loader prerequisite. Documents Fliplet.Media.parseSFC/evalModule, ordinary Vue screen blocks, runtime compiler loading and route integration; retains the existing generic asynchronous reactive-state example.

Tracked independently under DEV-2187 as framework documentation correctness. Replaces obsolete framework-document identifiers with canonical guide links and fetch paths. Studio PR #9017 requires this Vue contract before authoring asynchronous state.

JIRA ticket

DEV-2187

Result

  • Documentation unit suite: 184 passed.
  • Strict indexes and links: 207 documents passed.
  • Jekyll build and Markdown sibling generation passed; framework links and literal Vue bindings checked in rendered output.
  • Published SFC and loader executed with actual local SDK helpers and real Vue/jsdom: rendered Welcome and injected CSS. Evaluating raw SFC as JavaScript failed as documented.
  • Independent source review and diff whitespace checks passed. Only two source documentation files changed.

Checklist

  • Ran existing automated coverage and checked the published loader against the actual SDK.

Deployment instructions

Normal CLI developer-doc publication after merge to master. Can publish before the companion Studio update. No runtime API change or migration.

Author concerns

The existing branch and commit names retain their original DEV-2161 prefix.

Jekyll emitted existing warnings in unrelated pages. The SDK fixture verifies parsing, module evaluation and Vue rendering, not authenticated media fetching or live customer-app navigation.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying fliplet-cli with  Cloudflare Pages  Cloudflare Pages

Latest commit: bb1d357
Status: ✅  Deploy successful!
Preview URL: https://767c18bb.fliplet-cli.pages.dev
Branch Preview URL: https://feature-dev-2161-vue-runtime.fliplet-cli.pages.dev

View logs

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-07T07:50:28.938203Z bb1d357 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bb1d357ab4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

path: route.path,
component: function() {
return Fliplet.Router.resolveRoute(route.path).then(function(result) {
return loadVueScreen(result.content);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Handle denied route resolutions before parsing content

When a protected route resolves with allowed: false because the user has no session or the media request returns 401/403, the result has no content; this passes undefined to loadVueScreen, causing an exception instead of navigating to result.redirectTo. Check result.allowed and redirect or return a placeholder component before parsing, as required by the Fliplet.Router.resolveRoute contract.

Useful? React with 👍 / 👎.

## What to fetch next

After picking, call `get_fliplet_docs('v3-framework-<name>')` for the specific constraints. Every per-framework doc covers: loading the framework, features that need a build step (and what to do instead), wiring to `Fliplet.Router`, binding `Fliplet.Media.authenticate`, common errors, and DO/DON'T.
After picking, fetch the matching guide with `fetch_fliplet_doc({ path: 'API/v3/frameworks/vue.md' })` (or the `react`, `alpine` or `vanilla` path) for its setup and constraints. Every per-framework doc covers: loading the framework, features that need a build step (and what to do instead), wiring to `Fliplet.Router`, binding `Fliplet.Media.authenticate`, common errors, and DO/DON'T.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Pass the required URL to fetch_fliplet_doc

Agents following this instruction cannot fetch the selected guide because both MCP implementations define fetch_fliplet_doc with a required url field containing a full https://developers.fliplet.com/...md URL; path is not accepted by the tool schema. Replace this example with the canonical URL argument so the documented follow-up call succeeds.

Useful? React with 👍 / 👎.

@tonytlwu
tonytlwu marked this pull request as draft October 7, 2026 07:55
@tonytlwu tonytlwu changed the title DEV-2161 Correct Vue runtime SFC loading documentation DEV-2187 Correct Vue runtime SFC loading documentation Oct 7, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant