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

Feature Request: Interactive Documentation #14

Open
jgarte opened this issue Oct 28, 2022 · 3 comments
Open

Feature Request: Interactive Documentation #14

jgarte opened this issue Oct 28, 2022 · 3 comments

Comments

@jgarte
Copy link
Contributor

jgarte commented Oct 28, 2022

What do you think of having interactive documentation for chord-editor similar to this component library (same applies to other purescript/halogen component libraries):

For example, the action sheet component in the mint-ui library:

https://ui.mint-lang.com/components/ui-action-sheet

src:

https://github.com/mint-lang/mint-ui-website

mint is a language inspired by elm.

mint has ffi syntax similar to ruby's backtick shelling out syntax:

fun handleClick (event : Html.Event) : Void {
    `alert("Hello")`
  }

The above mint code does ffi with alert.

@newlandsvalley
Copy link
Owner

Well, we don't have a component library here yet. I have no knowledge of experience of mint. I'm not sure what you're suggesting - I wouldn't want mint inside my codebase, I think, but I'd be interested in the possibility of tooling written in purescript which could help in the generation of interactive documentation.

@jgarte
Copy link
Contributor Author

jgarte commented Oct 29, 2022

Sorry that wasn't clear. I wasn't thinking to introduce mint code to do this but was just using it as an example of what we could do with PureScript in order to produce interactive documentation when/if we have a component library.

@newlandsvalley
Copy link
Owner

Ah - I see. No objection to this at all, obviously.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants