from @mkdjr

repo

• add link to docs in repo description

readme

• link to tutorial page on website instead of jupyter notebook file, if desired

website

Index

• remove the "Welcome" heading
• put author information in an admonition? the current format as a quote block and code block signal (personally) that this information is optional, but i think it's important!

getting-started/01-installation

• add installation instructions for uv/pipx/pixi etc, if desired

getting-started/02-tutorial

• add body text before each code cell to provide context on what's being done and why
• label output numeric values (something like print(f"{M.mcc=}"))
• remove "Performance" heading
• number code cell lines, and code cells, if desired
• change code syntax highlighting to be darker (at least in light mode it is a little hard for me to read)

getting-started/03-performance

• expand first paragraph: how does your package handle this? introduce the following sections

api/contigent

• the properties admonition would be more readable as a list or table. alternatively, since they are listed below, consider removing the admonition entirely
• mcc property: if possible, provide citation for it's reputation as "most fair / least bias"
• define the acronyms TP, FP, TN, FN (if you feel it's appropriate for the audiance)
• if possible, provide type information for your parameters. I see that they are in your code, so I'm not sure why Zensical didn't pick them up. Maybe something in the python handler options
• add heading to deliniate properties from methods
• for method expected, it looks like there are only two modes: could you convert the mode parameter to take one of either aps and trapezoid (for example)? I think that would be more clear
  • nevermind, however, you should provide some documentation on the website for the ScoreOptions enum
• make sure all paragraphs begin with a capital letter
• link to objects provided by other packages, such as less_equal.outer in method from_scalar

api/plotting

• add example plot