zephyrproject-rtos / zephyrproject-rtos/ArduinoCore-zephyr
Improve Documentation
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 65
- Forks
- 93
- PR merge metrics
- No merged PRs in 30d
Description
The Docs folder has already been created in https://github.com/zephyrproject-rtos/gsoc-2022-arduino-core/pull/20 but it is mostly written in markdown.
In future it may be better to shift to Sphinx as it will look more professional and organised. Github also can build these docs and publish them on a website. See sphinx: github pages
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
Review the existing Docs folder and its Markdown content, then read the linked Sphinx GitHub Pages tutorial. The issue does not define a migration scope or specific files; first clarify the desired Sphinx structure and publishing setup. Done would mean an agreed documentation migration and a published documentation site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100