brycerussell / astro-headless-ui Goto Github PK

@changesets/cli is installed but needs to be setup

• Initialize changesets using pnpm changeset init
• Configure changesets
  • Make access public
  • Add other packages in repo to ignore list
• Add packageManager and engine to root package.json
• Add release workflow

The repo has testing but only for a few components. Tests need to be added for all of these components.

Adding tests sounds boring, but this is the most exciting and important part! As you create tests, you will discover problems with the component that you can fix. If you want hands-on experience exploring these components, this issue is for you.

Other tasks:

1. Upgrade test project dep to the latest versions
2. Add testing commands to package.json
3. Add testing action

The repo needs a playground in order to test changes

1. Create an empty Astro project at the root of the repo inside /playground
2. Add "astro-headless-ui": "workspace:^" to the playground package.json and re-install dep
3. Add a page with a component or two to confirm package is working

There is currently a demo for some of these components inside another repo: https://github.com/BryceRussell/pagination-example

Instead of being a separate repo, this demo could live a /examples directory

1. Move demo to /examples folder at the root of the project
2. Update demo dep to latest versions

The project needs better docs, we can use Starlight to create a documentation website

1. Create a Starlight project at the root of the repo inside /docs
2. Transfer markdown from the wiki into the src/content/docs folder
3. Configure Starlight (sidebar, title, description, home page, etc)
4. Move /images folder into docs at src/assets

These components were created a long time ago and a lot of them are poorly designed. All components that use scripts or styles should be removed (for now). That basically means everything goes except the components inside this section

In the future, these components can be revisited (like the theme components)

1. Remove these folders:

package
  client-components
  style-components
  scripts

2. Update package exports
3. Remove all other references to these components