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.

Sign up for GitHub

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

Jump to bottom

Documentation #214

Open
xoorath opened this issue Feb 2, 2017 · 2 comments
Open

Documentation #214

xoorath opened this issue Feb 2, 2017 · 2 comments
Assignees
@fish-fly
Labels
enhancement

Comments

@xoorath
Copy link

xoorath commented Feb 2, 2017

Hey,

Some documentation instead of just examples would be very helpful.

As a start, a low hanging fruit might be to add the table source code under the tables in the examples, with relevant includes in a head tag.

Example.html

<head>
    <!-- example table dependencies -->
</head>
<body>
    <!-- example table -->
</body>

Example.json

[ {}, {} ] and so on

What would be even better would be a doc describing the parameters you can provide to the table tag, a list of all features, and a document for each extension.
@GTANAdam
Copy link

GTANAdam commented Apr 23, 2019 •
edited
Loading

Agreed, this type of examples is one of the worst documentation I've ever seen. Sure, it's fancy but it provides no examples whatsoever, I'd rather see text on a blank page explaining stuff rather than see it working without explanations.

A good example of a simple and well structured documentation can be seen here: https://nakupanda.github.io/bootstrap3-dialog/

@wenzhixin
Copy link
Owner

@fish-fly can you help to improve this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fish-fly fish-fly

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@xoorath @wenzhixin @fish-fly @GTANAdam