vuejs / vuejs/docs

Integrate Web Publisher to facilitate the contribution on docs

Open
#2,056 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Since Stackblitz reveals Codeflow and the Web Publisher integration, it could be nice to add an option (as an opt-in one) to facilitate the edition of a page.

For example, instead of getting the link:
Edit this page on GitHub.

We could have:
Edit this page on GitHub or in live

Pay attention to the title on the live link

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 with the Web Publisher integration documentation and find where the existing "Edit this page on GitHub" link is generated for paths such as src/guide/introduction.md. Add the opt-in live link beside it, preserving the specified title, and verify that the documentation pages show both editing options.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.