tauri-apps / tauri-apps/tauri-docs

[request] Add dynamic linking to the V1 old version notice docs

Open
#3,263 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discuss enhancement
Dominant language
MDX
Stars
1.1k
Forks
887
Avg merge
2d 8h
Merged PRs (30d)
48

Description

Question you want answered

Where to find the V2 equivalent documentation for a V1 page?

Where did you look for an answer?

The answer is more a "go and find out" exercise of going to the V2 docs and searching from-scratch for the correct documentation page.

Page URL

No response

Additional context

Hi there,
I am the original author of tauri-apps/tauri-docs/#3258 .

A follow on feature that may be a nice QoL thing is if the link within the "Old Version Notice" on the V1 docs was actually "dynamic".
i.e. the link dynamically changes to the V2-equivalent link, if available.

Example:
The V1 window menu page would have an Old Version Notice that says:

This documentation covers Tauri 1 (old version). For the latest version, see https://v2.tauri.app/learn/window-menu/

Giving it a new issue as this is a much more tedious task, as the docs are not entirely 1:1, so a cheap an cheerful automation is likely out of the question.

Are you willing to work on this yourself?
  • I want to work on this myself

Contributor guide

Open the contributing guide

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 reviewing the V1 Old Version Notice and the corresponding V2 documentation pages, including the window menu example. Determine how an available V2 equivalent can be identified for each V1 page; done means the notice links to that equivalent when available and preserves a suitable fallback otherwise.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.