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

Each module: add tab with links to simple fiddle templates to fork as needed. #526

Open
dreaming-augustin opened this issue Dec 24, 2024 · 3 comments

Comments

@dreaming-augustin
Copy link
Contributor

This is a big task but we only need to get started, to make a precedent.

I noticed that the current maintainers often use https://jsfiddle.net/ . And it is often a burden to remind each person to create a reproducible simple sample.

By having a dedicated tab in each module, where we can list fiddles to use as starting point, two goals are archieved:

  • they complement the current documentation with full working examples, to use for developer as starting points.
  • maintainers can more easily ask people to check the samples, and if necessary fork one of them to reproduce a given bug...

The idea is to improve documentation over time, and save maintainer and support-team time and developer time by having developers ( = Fomantic users) as independent as possible.

I am mentioning https://jsfiddle.net/ because it is the service that appears to be used by current maintainers, but it could be any other similar service.

@dreaming-augustin
Copy link
Contributor Author

I just find out you have your own collection here: https://jsfiddle.net/u/lubber/fiddles/

The idea would be to organize these into the official FUI-Docs, so that they can be easily found, used as examples to learn from by FUI users, and ready to fork in case of a problem, speeding learning/development process for FUI users, and saving support time for FUI maintainers.

@dreaming-augustin
Copy link
Contributor Author

Call the new tab "Help".

So, for example:
https://fomantic-ui.com/modules/search.html
The documentation page about the Search module would have the following tabs:

Definition - Examples - Usage - Settings - Security - Help

Security is another standard tab I think many module should have.

Anyhow, Help might attract user attention, and if each support request leads to the documentation and the help page being improved, Fomantic-UI might become much easier to use for very beginners.

@dreaming-augustin
Copy link
Contributor Author

dreaming-augustin commented Dec 25, 2024

I mentioned jsfiddle, because that's the one that appears to be used.

There is also codepen:
https://codepen.io/daemondevin/pen/mddyNYQ
https://codepen.io/tag/fomantic-ui

I don't know about jsfiddle, but codepen has the advantage that its code can be embedded directly into the Fomantic website. (Edit: jsfiddle can too: https://docs.jsfiddle.net/embedding-fiddles )

Searching around, there are plenty of other alternatives.

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

1 participant