Skip to content

chore: fix broken doc links - #13391

Open
himself67 wants to merge 1 commit into
vuejs:mainfrom
himself67:chore/fix-broken-doc-links
Open

himself67 wants to merge 1 commit into
vuejs:mainfrom
himself67:chore/fix-broken-doc-links

Conversation

@himself67

Copy link
Copy Markdown

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe: documentation — repairs links that point at deleted or renamed paths

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

The PR fulfills these requirements:

  • It's submitted to the main branch for v2.x (or to a previous version branch)
  • When resolving a specific issue, it's referenced in the PR's title
  • All tests are passing: docs-only change, no source or test files touched
  • New/updated tests are included

Other information:

Follow-up to #13192 / #13187 — a few more dead documentation links.

These are easy to miss with a link checker because they all point into the dev
branch, which is frozen at 2022-07-13 (still 2.6.14, before the TypeScript
port). They return HTTP 200 while serving readers content that no longer matches
main. Four of them also reference paths that no longer exist at all:

Link Problem
tree/dev/packages/vue-server-renderer directory was renamed to packages/server-renderer
blob/dev/flow/compiler.js#L47-L59 flow/ was deleted in the TS port; ModuleOptions now lives in src/types/compiler.ts
blob/dev/flow/compiler.js same; SFCDescriptor now lives in packages/compiler-sfc/src/parseComponent.ts
tree/dev/src/platforms/web/entry-compiler.js now entry-compiler.ts
blob/dev/src/platforms/web/entry-server-renderer.js does not exist on main; the SSR sources are under packages/server-renderer/src

The remaining changes just retarget dev → main. I verified every replacement
path resolves in the current tree. The two "flow declarations" link texts are
relabelled to "type declarations" to match.

Not included, happy to add if you'd prefer them in the same PR:

  • .github/PULL_REQUEST_TEMPLATE.md lines 3 and 29 have the same stale
    blob/dev/.github/CONTRIBUTING.md links.
  • .github/CONTRIBUTING.md is stale in a bigger way — it still describes Flow,
    Karma/Jasmine, Nightwatch, ESLint, npm run commit, and src/server /
    src/sfc. That felt like a separate discussion rather than a link fix.
  • The CircleCI and Codecov badges in README.md are pinned to dev and there is
    no .circleci config on main, so they report a 2022 build state. Left alone
    since that is a maintainer call.

All of these pointed into the frozen `dev` branch, which still serves
pre-TypeScript 2.6.14 content, so they returned HTTP 200 while showing
readers the wrong code. Several also targeted paths that no longer
exist on `main`:

- `packages/vue-server-renderer` was renamed to `packages/server-renderer`
- `flow/compiler.js` was deleted in the TypeScript port; `ModuleOptions`
  now lives in `src/types/compiler.ts` and `SFCDescriptor` in
  `packages/compiler-sfc/src/parseComponent.ts`
- `entry-compiler.js` is now `entry-compiler.ts`
- `entry-server-renderer.js` no longer exists; the server renderer
  sources moved to `packages/server-renderer/src`
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