Skip to main content

Search and Top Navigation

#3926 closed bug (fixed)

Opened January 24, 2009 10:39AM UTC

Closed January 26, 2009 10:47PM UTC

documentation should also be accessible separately from demos

Reported by: rdworth Owned by:
Priority: critical Milestone: 1.7
Component: [meta] ui.docs Version: 1.6rc5
Keywords: Cc:
Blocked by: Blocking:
Description

In addition to the combined demos+docs (with demos at the top, and documentation in tabs below), it should be possible to view and navigate documentation stand-alone. This could be at urls like

http://ui.jquery.com/docs/draggable

http://ui.jquery.com/docs/dialog#options

http://ui.jquery.com/docs/dialog#options-modal

http://ui.jquery.com/docs/sortable#methods-serialize

http://ui.jquery.com/docs/accordion#theming

This way you can

1. link directly to a docs page that doesn't have demos above it

2. link more directly to a section, such as options, methods, theming

3. link even more directly to the description (and demo) of a specific option or method. This won't work on demos+docs because a) the principal content is the demo, and b) we use #hashlinks to go to individual demos

4. View all the documentation for a plugin in one page (no tabs)

5. Print all the documentation for a plugin in one page (no tabs)

Attachments (0)
Change History (3)

Changed January 24, 2009 10:40AM UTC by rdworth comment:1

summary: documentation should also be accessible separatly from demosdocumentation should also be accessible separately from demos

Changed January 24, 2009 10:40AM UTC by rdworth comment:2

description: In addition to the combined demos+docs (with demos at the top, and documentation in tabs below), it should be possible to view and navigate documentation stand-alone. This could be at urls like \ \ http://ui.jquery.com/docs/draggable \ http://ui.jquery.com/docs/dialog#options \ http://ui.jquery.com/docs/dialog#options-modal \ http://ui.jquery.com/docs/sortable#methods-serialize \ http://ui.jquery.com/docs/accordion#theming \ \ This way you can \ \ 1. link directly to a docs page that doesn't have demos above it \ 2. link more directly to a section, such as options, methods, theming \ 3. link even more directly to the description (and demo) of a specific option or method. This won't work on demos+docs because a) the principal content is the demo, and b) we use #hashlinks to go to individual demos \ 4. View all the documentation for a plugin in one page (no tabs) \ 5. Print all the documentation for a plugin in one page (no tabs) \ In addition to the combined demos+docs (with demos at the top, and documentation in tabs below), it should be possible to view and navigate documentation stand-alone. This could be at urls like \ \ http://ui.jquery.com/docs/draggable \ \ http://ui.jquery.com/docs/dialog#options \ \ http://ui.jquery.com/docs/dialog#options-modal \ \ http://ui.jquery.com/docs/sortable#methods-serialize \ \ http://ui.jquery.com/docs/accordion#theming \ \ This way you can \ \ 1. link directly to a docs page that doesn't have demos above it \ 2. link more directly to a section, such as options, methods, theming \ 3. link even more directly to the description (and demo) of a specific option or method. This won't work on demos+docs because a) the principal content is the demo, and b) we use #hashlinks to go to individual demos \ 4. View all the documentation for a plugin in one page (no tabs) \ 5. Print all the documentation for a plugin in one page (no tabs) \

Changed January 26, 2009 10:47PM UTC by paul comment:3

resolution: → fixed
status: newclosed

Done.