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

Create playground / documentation site #193

Open
JohnnyMorganz opened this issue Jun 16, 2021 · 0 comments
Open

Create playground / documentation site #193

JohnnyMorganz opened this issue Jun 16, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@JohnnyMorganz
Copy link
Owner

README is currently very long, with a lot of words, and maybe a bit too verbose - it could grow even further in the future.
We should cut it down, so its easier to find what you're looking for. Nobody wants to be searching through text.

It may also be wise to start up a separate documentation page, so we can split it up and go into more detail about things. I want to document more of the specific style choices made, to make it easier to see what is happening. Only issue with a documentation site is remembering to keep it up to date.
mdBook looks simple and clean, or maybe we should just use GitHub Wiki?

I also want to start hosting a playground to make it easy to quickly test StyLua, similar to prettier's playground - it would also be useful for users to report issues by pasting a playground sample. Started some of this on the playground branch, and its somewhat working, just need to design it now. It also requires stylua to be built for wasm - need to remember to keep that up to date, and I don't know how easy it is to build wasm to compare e.g. current HEAD vs. a released version.

@JohnnyMorganz JohnnyMorganz added the documentation Improvements or additions to documentation label Jun 16, 2021
JohnnyMorganz added a commit that referenced this issue Jun 17, 2021
@JohnnyMorganz JohnnyMorganz changed the title Simplify README and maybe make a documentation site Create playground / documentation site Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant