-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
developer-experienceDeveloper ExperienceDeveloper ExperiencedocumentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
To help humans and machines learn about defuss, three main requirements need to be met:
- Docs (website) exists and includes guides to learn about the concepts of defuss, including meaningful Mermaid diagrams; a quickstart guide allows setting up a project in under 5 minutes using
defuss-ssg, another 5 minutes fordefuss-ssr. Deployment to at least Vercel and Cloudflare Pages in about 10 minutes. - Docs (website) in-depth allow for understanding the purpose of every
package/*andexample/*- this is sources from the pre-existing{README,ARCH,QUICKSTART,DEVELOPERS}.mdfiles. - API Docs (website) outline every exported symbol (function, variable, type, field) available in defuss, of every package. Therefore everything that is declared, has to have a comment of /** why it exists, how and when it is to be used*/
Of course, this will be built with packages/defuss-shadcn based on packages/defuss-ssg. The client-side search will be powered by packages/defuss-search.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
developer-experienceDeveloper ExperienceDeveloper ExperiencedocumentationImprovements or additions to documentationImprovements or additions to documentation
Projects
Status
Todo