particle-iot / particle-iot/docs
Reformat HTML examples
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
I think the HTML examples at src/content/guide/getting-started/examples.md would be more clear if they were reformatted.
- It would be nice if they were strictly written in HTML and there was proper syntax highlighting. (Currently they are kinda written in C inside a comment)
- It would be nice if the "Paste the code between the.." text was outside of the
codetags, and was changed to explain that the code is now formatted as HTML. Perhaps a link to download the complete example as a HTML file would help?
Note that there's two seperate HTML code blocks on that webpage.
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
Open src/content/guide/getting-started/examples.md and inspect the two HTML code blocks rendered on the linked getting-started page. Reformat both blocks as HTML, move the instructional text outside the code blocks, and update it to describe the HTML formatting; verify the rendered examples and highlighting on the page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100