Commit Graph

4 Commits

Author SHA1 Message Date
c1bd7d653a Adjusted the Design Document.
The Design Document is now the Product Design Document (PRD).
It was rewritten to be a bit more in line with just describing the why
and what of the product, not the how. It might not be perfect, but it is
good enough.

The README was adjusted to document that we are using the weasyprint
pdf-engine for pandoc. I had started with just using the LaTex engine,
but when you get to heading level 4, the heading is classified as a
paragraph and not a proper heading.

Also, all generated documents (*.pdf) were removed from the repository.
2025-07-27 12:04:20 -04:00
aabcfc6a9a Added the generated design docs.
Also explained how to generate them in the README.md file.
2025-07-18 12:25:52 -04:00
1c593aff9b Initial pass on the design documentation.
The design doc and software design doc.
The UML images are generated with plantUML from the *.puml files.
2025-07-18 12:14:01 -04:00
46a23631e4 The build files and project documents.
This sets up the basic build for the microbit project. The documentation
needed to code against it has been assembled in the documents directory.
2025-07-18 10:37:31 -04:00