vuejs / vuejs/docs

Linking to Options API/Composition API not working

Open
#1,901 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

I really like that the website uses the same documentation structure for the Options API and the Composition API, and that one switch between them using the switch in the sidebar (upper left corner):

Screenshot 2022-08-10 at 09 42 53

But the choice in the switch is not reflected in the URL, so helping others by sending a link to the docs is annoying (one also has to explain make sure the switch is set to the XXX API each time).

So would appreciate if the the choice of the switch is reflected in the URL.

Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the documentation site's Options API/Composition API sidebar switch and how the current URL is built. Confirm how the selected API should be represented in shared links, then verify that switching APIs updates the URL and that opening a link restores the selected API.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.