Skip to content

Get into Dash user-contributed docs. #12

@michaelblyons

Description

@michaelblyons

Basically, increase discoverability by showing up in Dash search results.

Docset Guide recommendations

  • Contribute it to Dash (this ticket)
  • Set a Main Page
  • Add an Icon (I think this is already done by dashing.)
  • Support Online Redirection (This is easily done in dashing. Do we want that?)
  • Support Docset Playgrounds (N/A)
  • Enable JavaScript (N/A)
  • Enable or Disable Full-Text Search (N/A)
  • Host a Docset Feed (N/A if we're getting into Dash User Contrib)
  • Share a Docset Feed (N/A)

Docset Contrib Checklist

General Requirements

  • You must maintain your docset! Always update it to the latest stable version as soon as possible
  • You must try to fix any issues/bugs that might be reported

Docset requirements

  • The docset name must match the official API name (e.g., if you make a docset for PostgreSQL, don't call it psql)
  • The docset must not include a version in its Info.plist or in the docset filename
  • All pages must work offline (online resources are okay only if there's absolutely no way to avoid them)
  • The docset index must not contain entries with new lines in them or empty entries or broken paths
  • The docset must be for public use (i.e. don't contribute a docset that only you or your team will use)

Optional, but highly recommended

  • Docset should have an icon
  • Docset should have an index page set
  • Docset should have JavaScript enabled if it needs it
  • Docset should have table of contents support if it makes sense
  • Docset should be optimised for display in Dash
    • This generally means that the pages should work properly when the browser width is small, preferably with no horizontal scrolling
    • Any sidebars the pages might have should be removed and replaced by table of contents support or general docset entries
  • Page titles (<title> tags) should not contain the name of the docset; the user can determine the current docset by looking at the icon
    • Exception: docsets for a specific/older version should include the version number

Reference links

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions