cetz icon indicating copy to clipboard operation
cetz copied to clipboard

Even **incomplete online manual** of CeTZ v0.4.2?

Open Explorer-cc opened this issue 2 months ago • 1 comments

From the change.log at here, we know that in v0.4.2:

BREAKING The n-star element now takes the inner radius as a separate style key inner-radius (ratio or number) (#920)

Then I search the keyword with n-star at here:

Image

Then I can found this link:

https://cetz-package.github.io/docs/api/draw-functions/shapes/n-star/

and I can get:

Image

Analyze the link's path structure: /docs/api/draw-functions/shapes/n-star/:

However, I can't find any left-side label as below:

Image

That is to say, even if I click every item on the left-side label, both "DOC" and "API", if I don't know n-star in advance, I would not know there exists n-star feature.

This is such a terriable experience in referring the manual!

Also, as menthioned in #728, a complete PDF-version of manual is VERY important, which gives user to refer the manual on their local machine, and allow them to have a global view of what powerful feature that CTeZ provided, instead of just search online. I hope that the online manual could be complete and keep up-to-date, what's more, the stable PDF-version of manual could also be provided, which is good approach to promote user experience to make CeTZ even greater. Thanks!

Explorer-cc avatar Oct 08 '25 18:10 Explorer-cc

I've fixed some of the issues. The missing API functions should now appear in the sidebar – as this is a manual process, it is easy to forget. A documentation written in Typst is the goal, now that Typst HTML export is a thing.

johannes-wolf avatar Oct 09 '25 01:10 johannes-wolf