Please read - I would really like feedback on this proposal re documentation

Hi All,

We all love Wappler but from day one, users have complained about the documentation.

The team, rightly, focus on the application and dont really have time to invest in the documentation aspect. I know may have suggested the team should be expanded to allow for docs creation but that would, understandably, lead to a subscription price increase for all subscribers.

For several years, I’ve held a long-term aspiration; to develop a comprehensive learning portal tailored specifically for Wappler users. I briefly introduced this concept in the form of an eBook system at our last monthly meetup, but since then, the vision has expanded significantly.

It's something I have done in my professional life in the past at national / government organisation level so I have experience in this.

This won’t be just a documentation refresh - I am taking a full-scale transformation.

I’m envisioning restructured and enriched content featuring:

  • Freshly organized modules aligned with Wappler’s visual structure
  • Code examples to guide practical implementation
  • Sample videos for visual learners
  • Interactive demonstration pages where relevant
  • links to articles and videos supporting techniques, frameworks and relevant coding.

All of this will be created and managed within a purpose-built Wappler CMS I have crafted. The core of the application is already developed although some featues are still in development and testing phase.

Content will draw on contributers personal experience, curated forum knowledge and AI generated contributions to bring everything together into one cohesive learning package.

Let me be clear: I know this is an ambitious and long-term commitment.

I have spoken privately with the Wappler team, and I’m pleased to say they are supportive and onboard.

Before investing hundreds of hours into content development, I’m reaching out to gather feedback and gauge interest. Your thoughts and feedback will help determine the scope and direction of this initiativeand it's feasibility.

Costs
While I’d love to offer this completely free, the reality is that server infrastructure and AI token usage come with significant costs. My goal is to keep this “not for profit,” with a subscription model, pricing based on subscriber levels. The more, the cheaper it gets!

Tentative Timescales
Here’s an outline of the project phases (times are aspiratrional and may vary):

Phase Duration Focus
1 6–8 weeks Initial restructuring of existing docs, forum content, and AI integration. Alignment with Wappler UI.
2 Further 10–12 weeks Updating all content, refreshing document images, and ensuring version accuracy.
3 Ongoing Rolling addition of new topics, demo videos, and interactive examples. Routine updates to reflect Wappler enhancements.

I may be unrealistic with these targets, only time will tell. I hope to release this to free public access during the intial developent phase to allow users to see what to expect before moving it behind a paywall as content is enhanced.

I’ve already built a task-driven content management system that integrates with forum tagging making outdated documentation easier to track and address. I hope use of AI will increasingly support to this system as it evolves.

A key long-term milestone is multi-lingual support. The foundation for this is already laid within the application structure and AI translation will be leveraged to bring Wappler learning to a wider global audience.

Want to get involved?
This project is designed to be collaborative. If you’d like to contribute—whether it’s writing, proofreading, suggesting improvements, or helping with translations Your involvement, big or small, would be truly welcomed.
Sorry, there is no money available for this although success may lead to some compensation.

I’m delighted to share that Ben Plysier is already onboard, and I look forward to growing this initiative together with others who are passionate about Wappler.

As to the eBook idea, jury is still out on that one for piracy reasons, may do a cutdown free version in the future but not decided. The system is designed to be able to generate an eBook version automatically if needed so i can defer that decision until later.

Thanks for taking the trouble to read this.

15 Likes

Wow Brian. This sounds excellent and very much what is needed.

Count me in to assist in ways I'm able. Can't promise how much time I'll be able to give but am certainly up for helping with this.

:slight_smile:

Thanks, any help appreciated, even if it's just proof reading a few posts occasionally.

1 Like

That sounds amazing, Brian! Count me in as a subscriber for sure. :beers:

1 Like

This is potentially an excellent way forward to meet the long running documentation and subsequent learning issues with Wappler. I would be happy to assist if my limited skill set could be of use. Well done Brian a great initiative.

2 Likes

Hi Brian,
Add me to the list of contributors/proof readers/whatever else might be helpful.

As many have said before, thank you for everything you have done, and continue to do, for this community :heart:

I remember the first thing I did when I downloaded Wappler for the first time was to create a project called “Test” (not very original, right?).
Inside that project, I started trying out all the stuff I was learning from the docs and the few YouTube videos that were around back in 2019.

My rule was simple: name each file after the component or function I was testing, and focus only on that one thing inside the file.
To this day, I still use that method for every test I do (though I had to make an extra project when Node.js support came out :sweat_smile:).

Brian, I think your idea of bringing us together to collaborate on a shared project is awesome.
I love that you're encouraging those of us who use this tool every day — and who enjoy sharing tips, resources, and ideas — to build something as a community.

So I hope it’s okay if I take your idea one step further.
If the ultimate goal is to help people who are just getting started with Wappler (and also those of us still learning new stuff every day), what if we create a big collection of single-feature files?
Each one would focus on just one function or component, fully documented and with a working example.

And if the Wappler team is cool with it, maybe those files could even show up in the default "Project" screen — like the real estate project does.

It’d be a great way for all of us to contribute a little something inside Wappler itself.
Of course, always with the team’s approval and under the guidance of community legends like Brian and Ben.

Each contribution could be nicely documented, include a link to the related community tutorial (if there is one), and maybe even a YouTube video.
That way, we’re building a super useful, practical library that everyone can learn from, test, or even speed up their daily work with.

It might also help the team catch updates that break certain features more quickly.

And here’s a fun idea — the person who creates a practical example could add a “Buy Me a Coffee” link at the end of the file.
If someone finds it useful, maybe they drop them a coffee — and it might encourage more people to pitch in!

At first, it could just be a big index of links to all the practical examples.
No need for servers, subscriptions, or anything external — just knowledge-sharing for everyone and encouraging best practices.

We could host it all on a public GitHub repo so people can improve and contribute freely.

Just an idea to go along with the collaborative spirit of your topic, Brian.
Apologies if it’s a bit different from what you originally meant — but I think it’s all aiming toward the same goal.

1 Like

Hi Brian,
This sounds like an excellent idea - thank you!

To be honest, i have done that at the end of all my videos and now have the link on most of my nps also.
My revenue over about 4 years would not even pay a 1 year Wappler subscription!
It's a great idea ( have to say that as I have been doing it for years) but it really is coffee money, sometimes with a sandwich but nothing more.

As to structure, if you think of it like a book with chapters, sections, sub section and paragraphs, the entire system is built around an inverted tree which is based on the the Wappler menu structures
I will build the structure before release to contributers to keep it tight.

So for example it would have a path of Wappler Manual-> App Connect-> Components-> The Forms Group-> Form (all components within forms in fact)

I have custom modules to interface with the Wappler forum, pull down content and integrate it ready for editing. It also does full image restructuring to allow images to be clicked and opened as large images within an app connect dmx-html giving a lightbox effect.

Bit uncomfortable with opening up the code side of things at his time to be honest, a lot of custom integration in this.
All content is managed via a editor dashboard so no need to actually code anything.

I am looking at a mechanism to allow "custom pages" to be loaded dynamically so each page can include a working code example but it's not there yet. Lots of technical isses due to App connect security.
In the short term, personally i will build a page as it prepare the tutorial then look to publish it as a new page manually. Ideally each front end component should have a working demo page and probably a code download .zip file

Stage 1 is to document EVERY aspect of the UI and EVERY component. I say that with a proviso, Server Connect Stripe Components with be an entire volume on their own!

I will start (actually have started) by "pulling" all the current docs from the docs download George provided for us. I can also pull direct from the forum if necessary. This will create the "skeleton" of the system. All docs will then be updated and extended with text content and images.
I have a further custom module to scan the forum for any relevant content in "non docs" pages which could be used to "enhance" the content.
Videos will be created and added for every topic where it is appropriate otherwise animated gifs will show short animations.
Lastly will come the "technical stuff" like servers, docker etc.
Also, non wappler specific material which may assist users will be available such as bootstrap though to technical stuff like javascript tutorials sourced from public videos on YouTube etc
I could go on forever, my brain in racing at the moment.

Ah, the life of Brian, Brian :rofl: :rofl:

1 Like

This is sorely needed, especially for people wanting to try out Wappler before purchasing. If I had not had @mebeingken's initial tutorials and I would have had to rely on the documentation only, I doubt I would have stuck with Wappler when I was first testing it out. Now, I'm in Wappler at least 6 hours (or more) a day. I still find myself coming across something I hadn't noticed in Wappler before and need to try and find out what the feature is for and it's disheartening when I find the doc on it and it's incomplete or very outdated.

I'll help in anyway I can, but like sitestreet, I'm not sure how much time I'll have, but I will be a subscriber for sure!

-Twitch

1 Like

This is a thing I've thought about for years and kept coming back to (usually while banging my head against a question).

I'm down in whatever capacity you need me. I can also help with e-learning components if you want them, video post-production, audio, and building. I am at your service.

1 Like

Peaked my interest, what do you have in mind?
I remember using Dreamwweaver coursebuilder from 25 years ago!

I've expected something like this earlier.

Thanks for bringing it into reality. I'm eager to contribute.

1 Like

Well, I just spent the last year and a half building a training platform for incoming sales agents, so I still haven't gotten all that flushed out of my system yet.

But really, the sky's the limit.
Simulations
Interactive/Branching video
Drag and Drop, quizzes, interactive slide presentations
However, you think would help expose concepts and reinforce knowledge.

And I, too, remember Dreamweaver coursebuilder.. . and I always wake up after, drenched in sweat and muttering "not again" over and over into the dark.

But a lot of it would depend on how you're thinking of structuring things, and how you want "students" to go through it and where it's thought that alternate interaction methods would help.

The main one I would think of is software simulation (where basically you record a process and have the student "replicate" that process step by step with messages, text, and other bits of information. It basically allows them to perform a task without having to perform it on their own install/set up. It's also handy for showing other applications/setups that the user/student might not have (Docker Desktop, server hosting environments, etc).

But really, pretty much anything that can be thought of can be made.

I am at your call.

1 Like

Thats interesting. The initial idea is a reference guide rather than a training platform but that would definately open up some interesting possibilities for extending it.

I've always thought it needed both, espeically if we want to get "new" (both to the app and to the whole development thing). it works well for JetBrains (who have their IDE's and a whole educational platform attached. And there is a value of teaching the newcomers how to do the development stuff with this specific application. . that's how Adobe has survived.

But I agree it needs both a reference guide (how to use the app) and education (what you use the app "for"). It would certainly make it easier to bring baby users into the fold.

hell just imagine being able to offer "Wappler Certified Developer" courses.

1 Like

Ditto for me.

I'll volunteer to assist in organizing and coordinating status of content and volunteers so you can focus on the heavy lifting Brian or whatever you think I can help with. :slight_smile: