lancaster-university / codal-documentation Goto Github PK

Flags to enable for debug prints, how to enable those flags in MakeCode and MicroPython builds, etc.

We were considering having this information in the MakeCode and MicroPython documentation as well, but ultimately this is usually necessary when debugging from the CODAL layer, so this would be a good place to have them. And it'd be more efficient to have this in a repo like this one, rather than trying to find the "right place" (which might not exists yet) in MakeCode/MicroPython docs.

Tools such as winget as ubiquitous as it is, should still be linked from pages such as https://lancaster-university.github.io/codal-documentation/guides/prerequisites.html where they're mentioned first.

Suggest using https://docs.microsoft.com/en-us/windows/package-manager/winget/ as the link, as it includes stuff about installing it when it isn't present by default.

There is a bit of info in: https://lancaster-university.github.io/microbit-docs/advanced/

But, for example, nothing to indicate how to create a new fiber.

Currently, the build script downloads all dependencies, then compiles a blank application, and finally builds the documentation.

The compile phase is an unnecessary step, and just slows down the build, although it only happens once when testing locally as the binaries are cached anyway.

To fix, we'd need a 'download only' build phase, which does not attempt to run the actual arm build, then we can skip the compiler pull stage and the source build before moving on to documentation build steps directly.