Skip to content

Browser extension to switch to preferred version of documentation

Notifications You must be signed in to change notification settings

dougharris/unified_docs_switcher

Repository files navigation

Unified Docs Switcher

A browser extension that remembers which version of documentation you're using for programming languages, frameworks, databases, etc.

The problem this solves:

  1. Forget the syntax for Django query filters.
  2. Search google for "django query filters".
  3. Click on the link for official Django documentation.
  4. Notice that it's showing documentation for version 3.1 but you're using 2.2. It's probably the same syntax, but you've been doing this long enough to know better, so...
  5. Click to see the 2.2 version.

Twenty minutes later, you want to check the syntax for Django urls... repeat the same process. And then for Python regular expressions or PostgreSQL constraints.

Wouldn't it be nice if you were automatically seeing your version every time? That's what this extension helps with.

Would you like to see it in action? Watch this video.

This was inspired by django docs version switcher and py3redirect.

Platforms

This extension currently works for the following platforms' documentation:

Want a new one added? Let me know. See how Django handles this for text links or how Python handles this for a select list in the docsData array in the code.

Usage

Just browse. Whenever you explicitly change versions on one of the sites, your preferred version is stored. When you next visit a page on that documentation site, you'll be redirected to your preferred version if not already there.

Install

The extension is available on:

Bugs & Feature Requests

Troubleshooting: Pressing the extension's button on your browser's toolbar shows your current preferred versions for all sites. Clicking "Reset all to default versions" sets your preferred versions for all sites back to the default values.

Add an issue on the Github repo.

If you'd like to see a new documentation site handled by this extension, add a new issue with the "new docs template" label

Attribution

Icon by BECRIS on freeicons.io.

About

Browser extension to switch to preferred version of documentation

Resources

Stars

Watchers

Forks

Packages

No packages published