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

Document individual components with visible source code #6

Open
zshall opened this issue Mar 12, 2024 · 0 comments
Open

Document individual components with visible source code #6

zshall opened this issue Mar 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zshall
Copy link
Owner

zshall commented Mar 12, 2024

Currently the best way to know how Shell.css works is to view the source of the documentation site. This works but isn't ideal; every component that has functionality is used, but they're used to build the documentation itself. What if a user just wants to know the best way of creating a window, or a dialog box?

There should be clear-cut examples where the source code is visible next to what it produces. This may entail using Bootstrap Grid or there might be multiple versions using different CSS frameworks such as Tailwind or vanilla CSS for a grid system. Either way, we need to break down each component that Shell.css produces and all the main options for it.

@zshall zshall added the documentation Improvements or additions to documentation label Mar 12, 2024
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