Tomb component docs

[xsanctom]

docs: added amazing component documentation templates

📦 Published PR as canary version: Canary Versions

✨ Test out this PR locally via:

npm install @tablecheck/[email protected]
npm install @tablecheck/[email protected]
npm install @tablecheck/[email protected]
# or 
yarn add @tablecheck/[email protected]
yarn add @tablecheck/[email protected]
yarn add @tablecheck/[email protected]

[github-actions]

Unit Test Results

0 tests  ±0   0 ✔️ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit 06a928e. ± Comparison against base commit d191838.

♻️ This comment has been updated with latest results.

[SimeonC]

I think I prefer us to use more real code examples rather than images, or embedded SVGs for the case where we want some measurements.

One of the reasons for this is that we can have them adapt to dark/light mode and the other is that we have a lot of actual code examples rather than view only images.

[gazpachu]

I agree with Simeon's opinion, but I think we can merge this for now, so we can have a base to work on those improvements.

Also, I'd prefer if we move the Components to the Dev section. @xsanctom if you want I can do that and also squash the commits. ok?

[SimeonC]

I think once we've squashed the commits/pushed a new commit we should get the preview deploy to review. Originally this was targeting main not next which is why I think it didn't trigger.

But yea, dealing with the component previews in another PR is OK. Though I would like to remove the images for those for now and add them in other PRs when necessary as images generally shouldn't be committed to a repo if possible. The way git works is that every image ever committed into all branches are downloaded when you check out the repo so I want to avoid that if possible.

[gazpachu]

@SimeonC where do you suggest uploading the images (the ones with the measurements)?

[SimeonC]

TBH I've not got any good ideas around that. I've seen all sorts of things from using imgur or other free hosting sites, uploading into a github comment then using the CDN link that it resolves to. Maybe @DragonStuff has some good ideas? I kinda want that image CMS we talked about ages ago, just something that would allow us to have a S3 bucket/cdn-ish for these kind of images. (both for TK and also for our other projects like website/diner app etc)

[netlify]

✅ Deploy Preview for tablekit ready!

Name	Link
🔨 Latest commit	06a928e
🔍 Latest deploy log	https://app.netlify.com/sites/tablekit/deploys/635746e51f4b3d000a0d7566
😎 Deploy Preview	https://deploy-preview-132--tablekit.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.