Skip to content

Commit db21fb9

Browse files
docs: More tweaks to text and formatting.
1 parent db4dcdd commit db21fb9

File tree

6 files changed

+9
-3
lines changed

6 files changed

+9
-3
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ https://microbit-foundation.github.io/microbit-universal-hex/.
1818

1919
## Web Tool
2020

21+
<img width="30%" alt="microbit-universal-hex logo" src="docs/img/web-tool-screenshot.png" align="left">
22+
2123
An implementation example can be found in the
2224
[docs/examples/webtool.html](docs/examples/webtool.html) file. This web tool can
2325
generate a Universal Hex from two Intel Hex files.

docs/api-docs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ can be found here:
1212

1313
The source code is well annotated with docstring and
1414
[TypeDoc](http://typedoc.org) is used to generate the API pages.
15+
16+
![Screenshot of an API page](img/api-screenshot.png)

docs/img/api-screenshot.png

72.8 KB
Loading

docs/img/microbit-uh-logo-text.png

-160 Bytes
Loading

docs/img/web-tool-screenshot.png

51.8 KB
Loading

docs/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ Create Universal Hex files for the micro:bit.
1919
[API](api/){: .btn .btn-purple .mb-4 .mb-md-0 .mr-2 }
2020
[View it on GitHub](https://github.com/microbit-foundation/microbit-universal-hex/){: .btn .mb-4 .mb-md-0 }
2121

22-
<br><hr>
22+
<br>
23+
24+
---
2325

2426
This is the documentation for the micro:bit Universal Hex library.
2527

@@ -34,6 +36,6 @@ micro:bit Universal Hex from two or more micro:bit Intel Hex files.
3436

3537
## Navigation
3638

37-
- ️ The menu on the left shows you the available documentation pages.
38-
- ️ The header at the top contains search bar
39+
- ️ The header at the top contains a search bar
40+
- ️ The menu on the left shows you the available documentation pages
3941
- ⬇️ If you'd like to contribute to the docs there is an edit link at the footer

0 commit comments

Comments
 (0)