This issue is related to #3597, and tracks progress of documentation of public symbols.
At the time of the creation of this issue, this is the percentage of documented symbols for all packages under the @fresh scope on JSR:
I think it would be a good goal to aim for at least 80% to assuage JSR, but being closer to 100% documentation of public symbols would be even better. Not every exported type needs large text or examples, and a small description can often be helpful for users to learn the framework.
Progress
Tracking progress of packages with >80% documented public symbols.
This issue is related to #3597, and tracks progress of documentation of public symbols.
At the time of the creation of this issue, this is the percentage of documented symbols for all packages under the
@freshscope on JSR:@fresh/build-id: 0% - ⛔@fresh/core: 44% -@fresh/examples: 0% - ⛔@fresh/init: 100% - ✅@fresh/plugin-tailwind: 0% - ⛔@fresh/plugin-tailwind-v3: 0% - ⛔@fresh/plugin-vite: 0% - ⛔@fresh/update: 100% - ✅I think it would be a good goal to aim for at least 80% to assuage JSR, but being closer to 100% documentation of public symbols would be even better. Not every exported type needs large text or examples, and a small description can often be helpful for users to learn the framework.
Progress
Tracking progress of packages with >80% documented public symbols.
@fresh/build-id@fresh/core@fresh/examples: docs(examples): add module and public exports JSDoc for all entrypoints #3603@fresh/init@fresh/plugin-tailwinddocs: add JSDoc to @fresh/plugin-tailwind public symbols #3832@fresh/plugin-tailwind-v3@fresh/plugin-vite: docs(vite-plugin): add JSDoc and export public API #3604@fresh/update