"Documentation" hint

Oh, I wish it was that prose, but it isn’t.

Of course, I can on the server-side insert any response code in the Response’s object. But the front end only respects a few predefined ones. I have no idea if ERROR is 500 or the whole 5xx group.

CleanShot 2024-02-27 at 08.52.31

As a result, we have an inconsistency in approach.

Yes, I know where to find information on $_SERVER attributes, I was creating a sizable project many, many years ago in PHP (the worst time of my life).

However, typing them in manually, without the option to select from a list (preferably with a description), results in:

  1. easy to get confused and make a typo
  2. if someone is not in it every day, they have to waste time searching, and low-code tools, are supposed to RECOVER that time.
  3. Or at least a small “?” button referring to external documentation. Would that really hurt anyone?

Such examples can be multiplied.

2 Likes

For me, the need for ‘hints’ is paramount. The hints could be a short description of what’s expected and, even better, one or two examples. This will further speed up dev time considerably. All the time saved can easily be lost due to having to spend time using trial and error.

3 Likes

You can inspect the status returned from any server action by checking the status returned.
I.e. serverconnect1.status == 500

1 Like

I guess the 1000 dollar question is "how much extra would people be prepared to pay annually to have this level if docs?

1 Like

Hmm, I’m not sure that’s the question at all. That level of information should be a given with professional development software so I would expect it to be there already.

3 Likes

Yes but how often do we hear…

I have come from Bubble, it has amazing docs but is just way to expensive.
So I came over to wappler as it appears better but the docs suck. Why can’t wappler have the same quality of docs?

Wappler is basically a three man team, if people want better docs then does development stop or do they hire in more staff and put the prices up?

In an ideal world we all want everything but that’s a difficult call.

I got excited when they added two people to the team (Remi and someone else whose name I can’t recall) and their remit was the documentation. But I believe they’re no longer part of the team so it’s back to the three core people.

There must be enough in the bank to employ just one more person to specifically look at the documentation. And if all the posts about this are true, the number of additional paying users will more than cover that cost anyway.

I’m not asking for lengthy and thorough documentation on absolutely everything (although that would be a dream), I’m just looking for tooltips on every field so it’s really clear what is expected to be put in there.

1 Like

They took on extra staff members to cope with this type of demand for more comprehensive docs.

I’m with @sitestreet on this one, even having ‘hints’ in the UI would be a massive help. For an example, the FormatDate formatter has one which I use all the time, I’m constantly forgetting which formatting to use in a few of my date fields. Just being able to hover over it to find an aide-memoire is a big boost - adding this to all components of the UI would be a huge time saver.

This could be a good compromise for the team, providing a very useful productivity boost whilst also negating the need for uber-comprehensive documentation.

2 Likes

Yes, I did some work with romy, dre67 never seemed to get involved.
Romy was a good designer but not at all technical and for me, she was not really a good fit for the team. Not sure why she left.

Romy, yes, that was her name. I was close!

I believe the software already has the facility in place for tooltips as they appear in lots of places. It just needs a bit of time spent adding them to the rest of the places. I know it will involve time to do it but it will be massively worth it. If it was just addressed bit by bit each week - maybe one of the team spends an hour a week adding some tips - then it will soon plug all the gaps and make it sooooo much better for us users.

Or add a mechanism for Ambassadors to add help texts?

2 Likes

Yep, I’d be happy to fill in some gaps and I’m sure others would be, too.

1 Like

Great idea!

Thanks, this will help.

This is a very wrong perspective.

The question should be: “How many more clients would the project have had if the documentation was in place and supported the user every step of the way”.

1 Like

How about the good old Wiki? If you make sense of the structure, you could 1:1 use them to produce ‘internal documentation’ / hints etc in Wappler.

Basically,that’s what we have now

I think we should create a feature request on this.
Seems a good one.
Besides that:
I always thinked on something like this could be helpful on Wappler:
help-paint-createpictures-winxp

With instructions and examples but sounds like too much work. I’m able to help if that’s the case :slight_smile:

I’d easily pay $100-$200 a month if it meant Wappler improved 2x faster.

In that case I will call it a day and revert to VS Code.

4 Likes