particle-iot / particle-iot/docs
Offline doc accessibility via Dash and LovelyDocs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Dash's docset-generation documentation and the Dashing README, then reproduce the reported npm install issue. Define the Particle API content to package and verify that the generated docset works in Dash and LovelyDocs and is ready for the relevant contrib directory.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100