Skip to content

Website + Docs + Examples full circle (docs/website) #39

@kyr0

Description

@kyr0

To help humans and machines learn about defuss, three main requirements need to be met:

  1. 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 for defuss-ssr. Deployment to at least Vercel and Cloudflare Pages in about 10 minutes.
  2. Docs (website) in-depth allow for understanding the purpose of every package/* and example/* - this is sources from the pre-existing {README,ARCH,QUICKSTART,DEVELOPERS}.md files.
  3. 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.

Metadata

Metadata

Assignees

Labels

Projects

Status

Todo

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions