Skip to content

Commit 3c1a610

Browse files
Inline pages into docs/index.md and tweak contributing.md
1 parent 364cd13 commit 3c1a610

File tree

9 files changed

+33
-64
lines changed

9 files changed

+33
-64
lines changed

docs/contributing.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,8 @@ nav_order: 6
1111
Thanks for looking here! We'd love your help. The micro:bit project is only
1212
possible through contributions of companies and individuals around the world.
1313

14-
This project is managed on GitHub, and the best way to contribute is to jump
15-
into the GitHub issue tracker to see what is available. Planned features are
16-
marked with the "enhancement" label, and know issues are marked with the "bug"
17-
label.
18-
19-
[https://github.com/microbit-foundation/microbit-universal-hex/issues](https://github.com/microbit-foundation/microbit-universal-hex/issues)
14+
This project is managed on [GitHub](https://github.com/microbit-foundation/microbit-universal-hex), and the best way to contribute is to jump
15+
into the [GitHub issue tracker](https://github.com/microbit-foundation/microbit-universal-hex/issues) to see what is available.
2016

2117
If you're interested in working on any of these items, please respond to an
2218
existing issue, or file a new one, and mention @microbit-carlos.
@@ -37,8 +33,7 @@ occur.
3733

3834
## Bugs
3935

40-
Please report any bugs in the GitHub issue tracker:
41-
https://github.com/microbit-foundation/microbit-universal-hex/issues
36+
Please report any bugs in the [GitHub issue tracker](https://github.com/microbit-foundation/microbit-universal-hex/issues).
4237

4338
## Development Workflow
4439

docs/img/api-screenshot-2.png

-72.8 KB
Binary file not shown.

docs/img/api-screenshot.png

-67.9 KB
Binary file not shown.

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

-61.5 KB
Binary file not shown.

docs/img/web-tool-screenshot.png

-51.8 KB
Binary file not shown.

docs/index.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,44 @@ nav_order: 1
1212

1313
Create Universal Hex files for the micro:bit.
1414

15-
- [micro:bit Universal Hex Specification](https://github.com/microbit-foundation/spec-universal-hex) contains a lot more information
16-
about the file data format.
17-
- [GitHub](https://microbit-foundation.github.io/microbit-universal-hex/) contains general documentation for this
18-
library.
19-
- [The micro:bit Tech Site](https://tech.microbit.org) contains general technical information about the
20-
micro:bit.
21-
- [Universal Hex Creator demo](./examples/webtool.html)
22-
- [Universal Hex Splitter demo](./examples/separate.html)
23-
24-
---
25-
2615
This is the documentation for the micro:bit Universal Hex library.
2716

2817
Here you will find the available public API to convert Intel Hex strings into Universal Hex strings and vice-versa.
2918

30-
Originally the micro:bit hex files used the
31-
[Intel Hex format](https://en.wikipedia.org/wiki/Intel_HEX) and with the
32-
micro:bit V2 release a new hex format was created to be able to flash any
33-
micro:bit board version with a single file.
19+
## Universal Hex format
3420

35-
The Universal Hex file format can contain the binary data for multiple micro:bit
36-
board versions and this TypeScript/JavaScript library can be used to create a
21+
The micro:bit Universal Hex format is a superset of the
22+
[Intel Hex file format](https://en.wikipedia.org/wiki/Intel_HEX) designed to be
23+
able to include data for multiple targets into a single file. A Universal Hex file can contain the binary data for multiple micro:bit
24+
board versions. This allows the creation of a hex file that will work on micro:bit V1 and V2.
25+
26+
Detailed information of the Universal Hex format can be found in the [specification](https://github.com/microbit-foundation/spec-universal-hex).
27+
28+
This TypeScript/JavaScript library can be used to create a
3729
micro:bit Universal Hex from two or more micro:bit Intel Hex files.
3830

39-
## Navigation
31+
## Online tool
32+
33+
An implementation example can be found in the [webtool.html](./examples/webtool.html)
34+
in the repository and it is hosted in the
35+
[micro:bit Tech Site](ttps://tech.microbit.org).
36+
37+
This web tool can generate a Universal Hex from an Intel Hex file for micro:bit
38+
V1 and an Intel Hex file for micro:bit V2.
39+
40+
- [Universal Hex Creator](https://tech.microbit.org/software/universal-hex-creator/)
41+
- [Universal Hex Separator](https://microbit-foundation.github.io/microbit-universal-hex/examples/separate.html)
42+
43+
## Related documentation
44+
45+
[micro:bit Universal Hex Specification](https://github.com/microbit-foundation/spec-universal-hex) contains a lot more information
46+
about the file data format.
47+
48+
[GitHub](https://microbit-foundation.github.io/microbit-universal-hex/) contains general documentation for this
49+
library.
4050

41-
- ⬆️ The header at the top contains a search bar
42-
- ⬅️ The menu on the left shows you the available documentation pages
43-
- ⬇️ If you'd like to contribute to the docs there is an edit link at the footer
51+
[The micro:bit Tech Site](https://tech.microbit.org) contains general technical information about the
52+
micro:bit.
4453

4554
## License
4655

docs/online-tool.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/uh-format.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

typedoc.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
"projectDocuments": [
1111
// Order as per left nav
1212
"./docs/quick-guide.md",
13-
"./docs/uh-format.md",
14-
"./docs/online-tool.md",
1513
"./docs/contributing.md"
1614
],
1715
"readme": "./docs/index.md",

0 commit comments

Comments
 (0)