-
Notifications
You must be signed in to change notification settings - Fork 0
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 better documentation endpoints #248
Conversation
@AndrewGibson27 ps I just realized I wasn't linting typescript so working on those fixes now. |
I love this. TypeScript is wonderful in general, but I think your choice to use it on a documentation site -- where by definition things need to be broken into very granular types -- is spot on. You might well know or have thought about these things. Feel free to ignore if so.
|
Hey @AndrewGibson27, I finally had some time to get back to this. I appreciate your helpful tips.
I'm going to go ahead and merge this just to get the new github usage data up. It now has all of the new data viz instances! Thanks again for this review. I learned a lot from it! |
What's this PR do?
Converts the style-doc logic to use typescript which helps breaks down various parts of the style system (e.g. colors, modifiers, tokens) into different types.
Classes added (if any)
None
Classes removed (if any)
None
Why are we doing this? How does it help us?
TBH, this is probably complete overkill. I've been wanting to clean up that SCSS comment parsing step, which is what builds out the CSS data for the docs and this just kind of helped me bring order to that chaos.
@AndrewGibson27, there's a ton of code here and I don't want you to spend too much time sorting through it. The
style-doc.ts
part is the only real change and it only pertains to the docs — nothing that affects where queso styles are used. I'm sure I broke all the typescript rules along the way.FWIW
npm run dev
is faster with the cleaner, more structured style data.How should this be manually tested?
npm install
npm run dev
Just confirm the docs are loading properly and you don't run into any build errors.
There's a little blurb about the endpoints at the bottom of the about page, which should help sort through the new data output: http://localhost:8080/about/
Does this introduce a breaking change where queso-ui is used in the wild? If so, is there a relevant branch/PR to accompany this release?
Doesn't even merit a release