Better publint.dev

[bluwy]

With v1 incoming, I'd like to further improve the site to make way for its extensibility.

Goals

• Better documentation
• Better rules view
• Better information for general users of the package (not only package authors)

Routes

• / - Home (not much change needed)
• /docs/* - New documentation pages for API
• /rules/*
  • /rules/core - Core rules
  • /rules/publint-plugin-foo - Reserved path for future idea of auto documentation of external plugins
• /<pkg>@X.X.X - Lint results (not much change needed)
• /* - Fallback as packages and redirect to /<pkg>@X.X.X

Extensibility

The new site should have a way to select plugins from npm (via publint-site-plugin keyword?). It should also have a way to pick different publint versions (but mostly useful for debugging purpose I believe).

(Package related settings should update the URL so it's sharable)

Technology

The current site is a Vite MPA. When we have docs, this would probably not scale well.

Astro Starlight seems like the best choice as we can reuse the existing Svelte 4 code for some pages. I also prefer statically generating the site for simpler hosting.

Other thoughts

I've seen https://jsr.io and it seems pretty close to what I had in mind, but I think both can still complement well with different sets of checks and information.