From 7820d625f924bda663c44e3eb77a6bcac4562937 Mon Sep 17 00:00:00 2001 From: Matt Hillsdon Date: Tue, 28 Jan 2025 14:18:37 +0000 Subject: [PATCH] Docs tidying/tweaks --- docs/contributing.md | 8 +++----- docs/index.md | 14 +++++--------- docs/quick-guide.md | 10 ++++------ 3 files changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 0775f6b..b6784c3 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,12 +1,10 @@ --- -layout: page title: Contributing -nav_order: 4 --- # Contributing -## How To Contribute +## How to contribute Thanks for looking here! We'd love your help. The micro:bit project is only possible through contributions of companies and individuals around the world. @@ -14,7 +12,7 @@ possible through contributions of companies and individuals around the world. This project is managed [in this GitHub project](https://github.com/microbit-foundation/microbit-fs), and the best way to contribute is to jump in and fix/file issues. -## Code of Conduct +## Code of conduct Trust, partnership, simplicity and passion are our core values we live and breathe in our daily work life and within our projects. Our open-source @@ -31,7 +29,7 @@ should breaches occur. [Issue tracker](https://github.com/microbit-foundation/microbit-fs/issues) -## Development Workflow +## Development workflow This project follows a fairly standard node.js process: diff --git a/docs/index.md b/docs/index.md index 63cc3f0..2a235e8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,6 @@ -# micro:bit Filesystem - microbit-fs logo -This is the documentation for the micro:bit Filesystem library. +## Introduction This library can be used to add files with Python code (or any other content) into a MicroPython hex file, ready to be loaded into a micro:bit. @@ -14,13 +12,11 @@ This library can also generate [Universal Hex](https://github.com/microbit-foundation/spec-universal-hex) files to create a singe hex that can be loaded in any micro:bit board. -## Navigation +## Getting started -- ⬆️ The header at the top contains a search bar -- ⬅️ The menu on the left shows you the available documentation pages -- ⬇️ If you'd like to contribute to the docs there is an edit link at the footer +Read the [Quick guide](./quick-guide.md). -## Other Documentation +## Related documentation - [MicroPython user docs page for filesystem](https://microbit-micropython.readthedocs.io/en/v1.0.1/filesystem.html) - [The micro:bit Tech Site contains general technical information about the @@ -29,7 +25,7 @@ a singe hex that can be loaded in any micro:bit board. ## License This documentation, as well as the rest of the source files located in the -https://github.com/microbit-foundation/microbit-fs repository, is +[GitHub repository](https://github.com/microbit-foundation/microbit-fs), is released under the MIT open source license. SPDX-License-Identifier: MIT \ No newline at end of file diff --git a/docs/quick-guide.md b/docs/quick-guide.md index 0506ddb..c13fe96 100644 --- a/docs/quick-guide.md +++ b/docs/quick-guide.md @@ -1,10 +1,8 @@ --- -layout: default -title: Quick Guide -nav_order: 2 +title: Quick guide --- -# Quick Guide +# Quick guide ## npm package @@ -14,7 +12,7 @@ You can integrate this library in your project using the [npm package](https://w $ npm add @microbit/microbit-fs ``` -## MicroPython Filesystem inside a hex file +## MicroPython filesystem inside a hex file Initialise a File System instance with a MicroPython Intel Hex string and start operating on files: @@ -90,7 +88,7 @@ if (microbitFs.isAppendedScriptPresent(finalHexStr)) { } ``` -## Read Device Memory Info data +## Read device memory info data ```js var deviceMemInfoData = getIntelHexDeviceMemInfo(IntelHexStr);