statelyai / xstate-tools

Public monorepo for XState tooling
183 stars 36 forks source link

XState to md – how to generate documentation from xstate? #368

Open Diokuz opened 9 months ago

Diokuz commented 9 months ago

Hi there!

I found XState, and it is great! I can describe and use a state machine, I can visualize it, I can observe a state graph, and even generate test-cases from it.

Whats about documentation? I failed to google anything related https://www.google.com/search?q=how+to+generate+documentation+from+xstate

I found some docs for meta and tags, but failed to find any tools to generate docs from it.

Also, I have this message in my vscode when hovering the meta property:

The meta property cannot currently be used with the visual editor.

Do you guys have any plans for tooling which would generate documentation from xstate model?

davidkpiano commented 9 months ago

Hey!

We have a beta feature currently available to Stately Pro subscribers where you can export the state machines you create to Markdown: CleanShot 2023-09-17 at 09 33 35@2x

https://stately.ai/registry/editor/ddf4ca0e-5904-499d-9c4a-186dc5ca6900?machineId=58beffb5-fe8e-40b5-b321-cc596b9ac426

Here is what it looks like:


Git bisect flow

Git bisect flow.start

The initial state of the git bisect flow.

On SET_GOOD_COMMIT:

On SET_BAD_COMMIT:

On START_BISECT:

Git bisect flow.bisecting

State representing the bisecting process.

Git bisect flow.bisecting.testing

Testing a commit to find if it is good or bad.

On GOOD_COMMIT_FOUND:

On BAD_COMMIT_FOUND:

On BISECT_COMPLETE:

Git bisect flow.bisecting.goodCommitFound

A good commit has been found during the bisect process.

On REVERT_COMMIT:

Git bisect flow.bisecting.badCommitFound

A bad commit has been found during the bisect process.

On REVERT_COMMIT:

Git bisect flow.bisecting.bisectComplete

The git bisect process has completed successfully.

Git bisect flow.bisecting.reverting

Reverting a commit to continue the bisect process.

On REVERT_COMPLETE:

On REVERT_FAILED:

Git bisect flow.bisecting.revertFailed

Reverting a commit failed, so the bisect process cannot continue.

On RESUME_BISECT: