Conversation
elegaanz
left a comment
There was a problem hiding this comment.
Two small remarks to improve your README. The second is really more of a suggestion. We didn't really have these rules/tips in our package review process previously, which is why I didn't suggest them for the previous versions.
| @@ -24,6 +24,7 @@ fields and options the package has. | |||
|  | |||
|  | |||
|  | |||
|  | |||
There was a problem hiding this comment.
Actual image descriptions would be appreciated here. They don't have to go into much detail, but should convey the main idea behind the image to people relying on screen readers (or for whom the image couldn't properly load, for example if they have poor internet connectivity). You can imagine that you are reading the README to someone on the phone, and you have to describe what the images show with words, this generally helps to come up with a good alternative text.
| @@ -1,4 +1,4 @@ | |||
| #import "lib.typ": * | |||
| #import "@local/herodot:1.0.0": * | |||
There was a problem hiding this comment.
I think it would be nice to link to this file in the README too, so that users can use this file as a sort of reference: they can scroll through the PDF to find a timeline configured the way they want, and then navigate to the corresponding section of the source to copy it.
If you do so, updating this import to @preview would be better, as it would allow people to just copy/paste the file to get started, and get a valid result without further modification.
- added link to examples.typ in the readme
- added image descriptions
|
Great, thank you! |
I am submitting
Description:
Added the following fields for customizing the timeline:
also: