Skip to content

Commit 7b0493b

Browse files
docs: Add more pages to the main docs.
1 parent f1c8e32 commit 7b0493b

File tree

4 files changed

+46
-5
lines changed

4 files changed

+46
-5
lines changed

docs/api-docs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: default
3+
title: API Documentation
4+
nav_order: 3
5+
---
6+
7+
# API Documentation
8+
9+
The API documentation is generated independently of the rest of this docs and
10+
can be found here:
11+
https://microbit-foundation.github.io/microbit-universal-hex/api/

docs/contributing.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Contributing
4-
nav_order: 3
4+
nav_order: 5
55
---
66

77
# Contributing
@@ -17,18 +17,33 @@ nav_order: 3
1717

1818
## How To Contribute
1919

20-
WIP.
20+
Thanks for looking here! We'd love your help. The micro:bit project is only
21+
possible through contributions of companies and individuals around the world.
22+
23+
This project is managed on GitHub, and the best way to contribute is to jump
24+
into the GitHub issue tracker to see what is available. Planned features are
25+
marked with the "enhancement" label, and know issues are marked with the "bug"
26+
label.
27+
28+
https://github.com/microbit-foundation/microbit-universal-hex/issues
29+
30+
If you're interested in working on any of these items, please respond to an
31+
existing issue, or file a new one, and mention @microbit-carlos.
2132

2233
## Code Of Conduct
2334

2435
WIP.
2536

2637
## Bugs
2738

28-
Issue tracker: https://github.com/microbit-foundation/microbit-fs/issues
39+
Please report any bugs in the GitHub issue tracker:
40+
https://github.com/microbit-foundation/microbit-universal-hex/issues
2941

3042
## Development Workflow
3143

44+
This project follows a fairly standard node.js process:
45+
3246
- `npm install` to install dependencies
3347
- `npm test` runs the complete test suite
34-
- `npm build` create a build with all the output formats
48+
- `npm build` creates a build of the library in all the output formats
49+
- `npm docs` builds the API documentation into the `docs/api/` directory

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 1
1010

1111
{: .fs-9 }
1212

13-
<img alt="microbit-universal-hex logo" src="img/microbit-uh-logo.png" style="max-height: 100px; float: left; padding-right: 16px;">
13+
<img alt="microbit-universal-hex logo" src="img/microbit-uh-logo.png" style="max-height: 125px; float: left; padding-right: 16px;">
1414

1515
Create Universal Hex files for the micro:bit.
1616
{: .fs-6 .fw-300 }

docs/uh-format.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
layout: default
3+
title: Universal Hex Format
4+
nav_order: 4
5+
---
6+
7+
# Universal Hex Format
8+
9+
The micro:bit Universal Hex format is a superset of the
10+
[Intel Hex file format](https://en.wikipedia.org/wiki/Intel_HEX) designed to be
11+
able to include data for multiple targets into a single file.
12+
13+
This section of the docs is still a Work In Progress. For detailed information
14+
on the format please visit:
15+
https://github.com/microbit-foundation/spec-universal-hex

0 commit comments

Comments
 (0)