Documentation icon indicating copy to clipboard operation
Documentation copied to clipboard

Getting started is too hard to understand

Open rinpoo opened this issue 9 years ago • 4 comments

Let me show you by giving you my thought process while reading the getting started:

It starts with the overview where I'm told that php isn't working with zeronet that alone is such turnoff that I almost closed the page and ignored zeronet. At least write "not yet" because no php means anything php related like phpBB would have to be coded from scratch in javascript. Coding something like phpBB would take years. PHP is pretty much a must, without it there is no chance casual developers will use zeronet.

Then there is that basic structure with 0 explantion.

  • What is ZeroFrame.coffee? What does it contain? Why does it exist?
  • MySite.coffee = it's called my site does that mean I have to write in there in coffeescript?
  • all.js file Does that mean I have to put all my script files in there?

The coffee files will allow me to use ZeroFrame API. What is ZeroFrame? Why do I need to use it?

At least the content.json is explained a bit.

Then ZeroNet Debug mode and Extra features

  • I thought this is a getting started? I don't even know how to use the ZeroFrame API yet.

Copy ZeroFrame.coffee to your site's js/lib/ directory

-link to ZeroFrame.coffee is broken, thus ending the whole tutorial. Oh well I can still rad a bit further.

-The code block has 0 comments So do I need to learn coffescript just to be able to make a website for zero net? Ill just press next and see how it goes further.

ZeroFrame API Reference

  • Where did the tutorial go? Great an API without any kind of explanation. The examples are just blobs of code without any comments.

There is written: These commands handled by wrapper frame and does not sent to UiServer using websocket.

Which makes it worse:

-What is the wrapper? How does the wrapper work? Why does it not send to UIServer. What is the UiServer?

With this kind of getting started nobody will be able to make websites for zeronet. The result is that ppl leave and wait for zeronet to get more userfriendly. Or join your irc channel and bother you like I did.

rinpoo avatar Mar 07 '16 14:03 rinpoo

Writing a good documentation takes time and there was not much attention of ZeroNet until now. The best way to start learning ZeroNet is the tutorial @ ZeroBlog site. I will remove the outdated one from the readthedocs site.

I think if you have javascript knowledge it's pretty easy to understand what zeroframe.coffee helper does. Coffeescript is compiled to javascript, so you can use it if you want.

Using PHP is not possible, because it's a server-side language and there is no servers in zeronet.

HelloZeroNet avatar Mar 07 '16 14:03 HelloZeroNet

That kind of information is needed in a getting started. No server side scripting means the coding process is completely different. That means pretty much every tutorial on the www is usless if you want to make websites for zeronet. Code examples that show that kind of difference are needed then.

rinpoo avatar Mar 07 '16 14:03 rinpoo

That means pretty much every tutorial on the www is usless

@rinpoo I think those single page application with websocket tutorials are helpful for ZeroNet site development.

weakish avatar Dec 18 '16 07:12 weakish

I'm tackling some stuff currently that will end up with my creating some PRs for documentation...I actually like developing front-end sites just for ZeroNet's "runtime". More to come...

mishfit avatar Mar 27 '17 21:03 mishfit