jquery / jquery/api.jqueryui.com

Link to demo on each widget page that has one

Open
#176 31 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
73
Forks
74
PR merge metrics
No merged PRs in 30d

Description

Picking one idea from #115:

There should be a link to the corresponding demo page on each widget page. It should be styled to stand out. A good spot might be to the right of the page title, somthing like this: http://bassistance.de/i/109e80.png (not really this styling, something that looks good).

This would also work for jQuery Mobile. Since the URLs don't have the same scheme, a good option might be to implement an optional attribute or element in the XSLT that gets output as a link, if present. So we'd just add the URL to the demo where it applies.

We should also make the link to the API documentation much easier to spot on our demo pages. The style of both links should probably be the same.

If that sounds good, I can create tickets in the appropriate repos, along with patches.

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 locating the XSLT that renders widget pages and the existing API-documentation links on demo pages. Review the proposed optional attribute or element and the related jQuery Mobile URL differences; done means applicable widget pages expose a prominent demo link and demo pages make the API link equally visible.

Written by the indexing model from the issue text.

Assessment

Tech stack
jquery
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.