Skip to content

Offline doc accessibility via Dash and LovelyDocs #773

@jtzemp

Description

@jtzemp
Contributor

I've been traveling a lot lately and have wished there was a good way to get Particle's docs in an offline format. I use Dash on a Mac and LovelyDocs on Android (which uses the same file format as Dash) for viewing documentation for other projects/languages/frameworks offline.

It'd be rad if someone would create a Particle API docset for Dash and submit it to their contrib directory. It shouldn't be too hard for an MVP/POC, but it also probably wouldn't be trivial to make it be up to Particle's high standards.

Dash has some docs here on how to generate a docset and there's a 3rd party tool called Dashing that might simplify some things. (I tried it late last night on a whim, but ran into npm install issues that I didn't have time to sort out.)

I'll also request the Dash team create it as an officially-supported docset, but I figured I'd ping both groups.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jtzemp@anatoly-particle

        Issue actions

          Offline doc accessibility via Dash and LovelyDocs · Issue #773 · particle-iot/docs