Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a dev log to the repo to show how each challenge is solved in it #206

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions DevLog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# A gathering of tips and tricks along the way

During the process if making this library, I encountered a series of new challenges that were both hard and fascinating.

This page is a log of each of those challenges and the solutions found to them.

## Run Cypress CT on React & Vue

In one single run?

- Use JSX to write tests both in vue & react
- What of the conflict between the two definitions
- Solution: Use Sucrase to transpile JSX for react instead of esbuild
- why is there a rootstory file and what will happen to it in the future?

## Building components

- turbo to build them in dependency order and cache the builds
- use vite to build Vue (why)
- use rollup to build react (why)
- `--watch` cant work in a monorepo with a dependency graph
- Solution: `scripts/watch-constants.mjs` runs esbuild when necessary

## The docs

- vitepress config
- theme layout
- dark mode switch
- SideBar links where the pages come from
- ordering the sidebar links
- page outline: how to make it live and wait for the content to load before running
- component pages generation
- docgen-cli both for React and Vue
- the `scripts/generate-docs.mjs` script to generate the non framework pages and why
- vue-live
- React & Vue
- md-plugin
- DemoWrapper
- some challenges around css leaking from markdown to the demo
- Figma links
- layout
- md-plugin
- Edit buttons
- the vercel git environment
- vscode magic protocol
Loading