particle-iot / particle-iot/docs
Generate firmware documentation automatically
Open
Nobody has claimed this yet.
tooling
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
Generate firmware reference docs from the firmware repository.
Fixes #472
Fixes #460
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 by locating the documentation-generation setup and how this repository can access the firmware repository; the issue names no files, tests, or entry points. Define the generation flow and its output before implementing it, with the work complete when firmware reference documentation is generated automatically and the linked issues are resolved.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100