Skip to content

docs: generate component document per registry #83

@debuggingfuture

Description

@debuggingfuture

With #62 we built registry at `apps/registry/public/r/@geist/ (.json) aligning shadcn schema

  • study shadcn
    • shadcn use mdx to build the docs - example

Goal

  • we want to auto gen docs as much as possible.
    • the registry item in .json already pick up jsdoc (title, description of the component)
    • a script generating onto content/ under docs, our build process will pick up and show on sidebar
  • the doc for component should show
    • sample command line (with geist registry path)
    • dependencies
  • we should integrate storybook
    • for the actual working example
    • low hangingfruit is to embed our hosted storybook (only for deployed components) https://storybook.js.org/docs/sharing/embed
    • we can have the flexibility that if we want customized docs for particular component, we add on storybook (.mdx) and embed
  • future potential way is embed the storybook "runtime" onto astro

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions