myrddin/microbadge
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Adjusted the Design Document.

Browse Source 
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.
This commit is contained in:
Myrddin Dundragon
2025-07-27 12:04:20 -04:00
parent 84ff23655c
commit c1bd7d653a
5 changed files with 269 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -98,13 +98,16 @@ cargo embed
## Documentation
To generate all the documentation you will need to have pandoc and weasyprint
installed.
### Design Doc
The [Design Doc][./docs/design.pdf] is generated with pandoc from the markdown
file.
```bash
pandoc ./docs/design.md -o ./docs/design.pdf
pandoc ./docs/design.md --pdf-engine=weasyprint -o ./docs/design.pdf
```
### Software Design Doc
@ -113,7 +116,7 @@ The [Software Design Doc][./docs/sdd.pdf] is generated with pandoc from the mark
file.
```bash
pandoc ./docs/sdd.md -o ./docs/sdd.pdf
pandoc ./docs/sdd.md --pdf-engine=weasyprint -o ./docs/sdd.pdf
```
### UML