Skip to content

Docset Versioning Guidelines

Bogdan Popescu edited this page Apr 17, 2014 · 2 revisions

What you need to be aware of:

  • Dash determines if an update is available just by performing string comparison (equality)
  • You should only update docsets to stable versions, but you can also update to betas if it makes sense. You can also provide docsets for beta versions as a specific_version in the docset.json
  • You should use the same version as the API the docset is for
  • Anything that comes after a / inside the version is not displayed to the user at all. You can submit updates without changing the displayed version by adding anything after a /. For example, if the version you want to display to the user is 1.0.0, you can still make Dash update a docset by setting the version to 1.0.0/whatever and the user will only see 1.0.0
  • If you don't want Dash to display any version to the user, start the version with a /. For example: /1.0.0
Clone this wiki locally