Thoughts on Documentation


#1

I just wanted to get a general idea of what people are feeling about the documentation in Wappler currently.

Wappler Official Documentation has 108 mini tutorials currently, covering almost all subjects that could be confusing. As new documentation becomes available I try to keep this post updated and keep it in it’s story type format which I feel makes it easier for new users that have no clue where to begin.

While the https://community.wappler.io/c/docs category has all the same mini tutorials but in parent / child category format, which is easier for the user looking for a specific topic of learning.

Obviously whatever is not covered is generally quite quickly and eagerly answered within the community forum, by either the Team or helpful users, and many times can be found in the Wappler YouTube channel which @ben has added quite a bit to, or @Hyperbytes website, or my own site.

My thoughts are only that the mobile side of the documentation is a little lacking, but as for the normal day to day stuff, I personally think it is quite well documented at this point.
Depending on the comments generated here I am prepared to try help making more documentation available and I am sure the other @wappler_ambassadors will assist too.

Please keep in mind this is not a question I am asking so we can help a specific use case website work but more of a broad question, such as what actual concepts are missing from the documentation in your opinion.


#4

Yes.i think the lack of documentation re mobile is a bit of a chicken and egg situation; not many of us have done much in that field so few of use have the expertise to write tutorials and few of use try to make them as we don’t have the expertise so there are few questions related to that. (try formulating that statement in a bunch if if/then’s - lol)
Making things worse, when a question is asked, few of us know the answer!
But as always i am happy to provide whatever assistance i can on any topic i have the expertise in.


#5

Agreed, I think most of us are php. Mysql. Website and dashboards.
When people ask about aspx or something I see many of us go quiet, as with mobile and ftp issues. Lol.


#6

We are updating the docs, and i will be adding more mobile tutorials soon.
I want to cover all the basics for web apps first - for example people are still asking for things like multi upload etc. :slight_smile: but i am slowly updating them.


#7

Well if you need help getting the web ones done Teodor just ask, I could do a multi upload doc if you wanted and probably a few other website ones, as far as the mobile ones go though I would be little use on that I’m afraid.


#8

Hi Paul,
I was not referring to some specific tutorial i need help with :slight_smile:
It’s just that some things that seem obvious to me, i mean - following the logic in Wappler, even without docs i would have thought they are easy to figure out, are not so obvious for some of the users (i am in no way saying that this is bad/wrong!).

I will try to update the docs next few weeks so that they cover most of every new user’s questions :slight_smile:


#9

I’m not asking for anything but wanted to give you a newcomer’s perspective. I know the documentation takes time and it is really hard to get right and keep current so just mentioning this in case it is not something you pros think about (just trying to help with my questions)

Yesterday Teodor showed me what validate could do - up until then I had noticed it (just like a lot of other stuff) but did not understand how or why to use it. I don’t think a lot of the options are documented (at least not the last time I read it). It would be very very helpful if all of the options just had some info available. Just an explanation of what they do / can do, would really help.

Another thing is (see below) sometimes I don’t see the {>} symbol and I have no idea what I’m supposed to be inserting (or what it would do). Is that just something that is unfinished in Wappler or just something that everyone but me knows about?

Anyway no need to spend time explaining it just wanted to let folks know how much I still don’t know :smiley:

2018-12-14_09-04-40


#10

Norm, static events are for running custom js code :slight_smile: that’s why there is no dynamic data picker. You just call your js code/function there.
Example:
alert('i like pizza')


#11

Thanks - that makes sense :smiley:

alert('i love pizza')

#12

haha, haha, I think we have all felt like that from time to time Norm, lol, tanks for the laugh.


#13

Adding to your point of not knowing what those icons mean, I also don’t know what Modifiers and Debounce mean.
I found this few days old tutorial showing a use case for Modifiers and explaining that Debounce is delay.
I still don’t know what many components and server action options mean. And if I can’t find it here, it probably won’t show up on Google either.

Some times, I find that searching for things on DMXzone helps. And for other times, I just trouble @George and @Teodor with private messages. :sweat_smile:


#14

Sorry guys, we are doing our best with the docs. I hope to get everything documented really soon.


#15

Thanks - that makes me feel a little better - I have so much respect for the folks that know all this stuff…


#16

Ditto. I sometimes feel I am wasting Team’s time with my basic questions when they can be spending their time working on making Wappler better.

But, documentation is SO SO difficult, yet important. You always miss out something and not everything can be explained in one example.
When the docs are more detailed, i’m sure more people will easily switch to Wappler.


#17

No need to apologise @Teodor, the documentation has grown massive in a very short amount of time, considering you are trying to document everything from the entire Bootstrap 4 framework website, and w3schools, and javascript, and jquery, and font awesome, and php, and so many more. As a single person I think you are doing an awesome job, just wish i was more capable to try assist more.


#18

Just a quick note on ‘debounce’. It can be very helpful to performance. Eg if you have a search field which searches on ‘updated’, a query will be sent for every keystroke. So if you search for ‘something’, 9 queries will be executed - however fast you type. If you set debounce to 500 for example, and type at a normal speed, then only one query will be executed.


#19

Yes, debounce value is in milliseconds so everything above 300 should be working fine for normal typing :slight_smile: