Replies: 1 comment 2 replies
-
Hello! This topic has come up before, and you are not the only one disappointed by the quality, quantity, and organization of the documentation on the official website. It's hard to make something that is accessible to both non-developers who are making their first app and to advanced users that want custom html, css, and js; but I'm sure we can do much better. I'm in favor of doing as much as possible using SQLPage itself, and extending SQLPage itself when we need things we cannot do yet for the documentation. SQLPage does support the inclusion of markdown files, so this shouldn't prevent writing a lot of the documentation in individual .md files now. Would you be interested to write small markdown guides about some of the topics you mentioned above? |
Beta Was this translation helpful? Give feedback.
-
I am making a minimal admin panel with sqlpage and I am comming to the conclusion that documentation could benifit from another paradigm.
I love the fact that the webpage uses sqlpage itself, but I can't help to think that that might be holding back documentation quality.
I have found most of the things I am looking for, and once I find them, they are well explained. However it is not trivial to find them. For example, I am looking into how to add custom css or how to add static assets, and I can't seem to find it.
The components page is where most of the stuff I wanted to know was. But I have never thought writting components is actually a basic workflow, on which many things rely.
In my opinion, this projects maturity and usefullness are already calling for the next step documentation wise.
A linear document with a structure of chapters and subchapters like postgresql documentation would provide a straightforward way to quickly find a bit of information.
Perhaps its time to swith to another documentation system. I would suggest something in the lines of mdbook or similar
Edit: another suggestions that I am sure many people would find usefull and use often: a cookbook page, often times also called FAQs.
There is the examples folder, but one needs to dig into the files and hope to find a useful example.. The examples in the readme are a good start but they only have the code and an image. A list with a textual tittle and a paragraph or two, would be more usefull. Example of a list of things that I needed to chase that could be place in a cookbook:
Beta Was this translation helpful? Give feedback.
All reactions