How does this project work?

[jcbhmr]

This is an issue tracking the documentation of how this website works. It's not necessarily a question per-se, but more of a "heyyyy let's document this stuff somewhere so we're all on the same page" issue.

[jcbhmr]

btw I was requested by @conartist6 to do something with this website in iter-tools/regex#47 (comment)

sooooo... yeah. we'll see what I can do if anything ❤

[jcbhmr]

Here's some info from the readme:

This is a Next.js project bootstrapped with create-next-app. It is using the Grommet component library and Typescript.

[conartist6]

I did some work on it the other day: #2

[conartist6]

The main goal is to visualize the states that are active in the engine. The engine states form a tree structure, and each state has a matcher, which can be represented either as a regex literal or as a graph structure as presented in a traditional railroad diagram visualization.

[conartist6]

In terms of the matchers, those are defined in regex.ts. The type and props properties will be the important ones for building visualizations.

[conartist6]

My rather medicore attempt to print matchers that powers the current playground is here

[jcbhmr]

Are we OK with splitting things out into new components, or do we want to freeze the components as-is and just add more stuff to them? Should the new components (the ez one that I spotted is abstracting the main <form> into its own thing) have the same React class-based components, are are we OK with new function-based components? Do we want to pick one over the other, or should we migrate to one? ANy preferences?

I note that some have function-style

if this were moved to a new component, we could then add more stuff to the main <App /> component like more docs, a header text, some more links in a footer, maybe a GitHub badge, etc.

[conartist6]

Don't worry about offending me. If you think you can make anything better by changing how it's factored, where it lives, how it's documented, go right ahead!

[conartist6]

I've given you write perms on the repo, so feel free to put your work in a branch here.

[jcbhmr]

Sounds good! 👍