About Store Forum Documentation Contact
Donations:
345$/mo



Post Reply 
Documentation
Author Message
Esenthel Offline
Administrator

Post: #1
Documentation
I've started working on new Documentation:
http://www.esenthel.com/?id=doc

Please let me know if in addition to the topics listed on that page, and that are not already included in the old doc - http://www.esenthel.com/wiki/index.php?title=Main_Page
is there anything more that you want to be covered?

Thank you
02-01-2014 04:59 AM
Find all posts by this user Quote this message in a reply
Rubeus Offline
Member

Post: #2
RE: Documentation
FYI, anything after the Welcome and Istallation folder shows "Can't access page". Although this may be because it's not done yet.

I think this method is a LOT nicer than the wiki-style layout. I personally would like to see all the information from the wiki moved there and a search added.
02-01-2014 02:58 PM
Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #3
RE: Documentation
(02-01-2014 02:58 PM)Rubeus Wrote:  FYI, anything after the Welcome and Istallation folder shows "Can't access page". Although this may be because it's not done yet.
Thanks, yeah it's still WIP wink
Quote:I think this method is a LOT nicer than the wiki-style layout. I personally would like to see all the information from the wiki moved there and a search added.
That's my goal, although search would be difficult.
02-01-2014 10:06 PM
Find all posts by this user Quote this message in a reply
gwald Offline
Member

Post: #4
RE: Documentation
looks nice and organised, does google crawl it?
I agree Without search, it's not that useful.
02-02-2014 01:20 AM
Visit this user's website Find all posts by this user Quote this message in a reply
candam Offline
Member

Post: #5
RE: Documentation
(02-01-2014 10:06 PM)Esenthel Wrote:  
(02-01-2014 02:58 PM)Rubeus Wrote:  FYI, anything after the Welcome and Istallation folder shows "Can't access page". Although this may be because it's not done yet.
Thanks, yeah it's still WIP wink
Quote:I think this method is a LOT nicer than the wiki-style layout. I personally would like to see all the information from the wiki moved there and a search added.
That's my goal, although search would be difficult.

I could help you with the search feature

I know that you're making different files for every section but we will have to make it dynamic and save the docs in the database
What do you think ?
This way will will have a better control over everything !
02-02-2014 11:35 AM
Find all posts by this user Quote this message in a reply
margul Offline
Member

Post: #6
RE: Documentation
or just just keep the file as is, do a php page that runs the grep output, strip the html and display it.
02-02-2014 11:48 AM
Find all posts by this user Quote this message in a reply
candam Offline
Member

Post: #7
RE: Documentation
(02-02-2014 11:48 AM)margul Wrote:  or just just keep the file as is, do a php page that runs the grep output, strip the html and display it.

Php is designed to do well with databases .
so far the results of using a database to store information will give us a better control flow and a better editing and updating management ! smile
02-02-2014 12:00 PM
Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #8
RE: Documentation
Currently I have each page as a separate PHP file, but I'm thinking of duplicating the same thing for SQL just for search purposes.
I'll play around with it once all documentation has been done wink
02-02-2014 09:00 PM
Find all posts by this user Quote this message in a reply
candam Offline
Member

Post: #9
RE: Documentation
Good job smile Hoping for it to be completed
02-02-2014 09:49 PM
Find all posts by this user Quote this message in a reply
gwald Offline
Member

Post: #10
RE: Documentation
Oh.. I just remembered.. what about http://www.doxygen.org
Doxygen is the de facto standard tool for generating documentation from annotated C++ sources.
02-04-2014 04:08 PM
Visit this user's website Find all posts by this user Quote this message in a reply
krokodilcapa Offline
Member

Post: #11
RE: Documentation
Is it possible to give some mark to that tutorials what aren't avaible yet?
02-08-2014 12:19 AM
Find all posts by this user Quote this message in a reply
aceio76 Offline
Silver Supporter

Post: #12
RE: Documentation
(02-02-2014 09:00 PM)Esenthel Wrote:  Currently I have each page as a separate PHP file, but I'm thinking of duplicating the same thing for SQL just for search purposes.
I'll play around with it once all documentation has been done wink

Oh I hope you aren't recreating the wheel here smile While I like the format, I'm concerned about how this approach puts an almost exclusive reliance on you to maintain the documentation. If you have plans on letting others assist (with proper permission, etc) then please pardon my rant.
02-08-2014 04:11 AM
Visit this user's website Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #13
RE: Documentation
(02-08-2014 04:11 AM)aceio76 Wrote:  I'm concerned about how this approach puts an almost exclusive reliance on you to maintain the documentation.
Who else would do this if not me? smile

If anyone wishes to help, submit articles, they're free to send me HTML code which I can upload to the server.
02-08-2014 06:38 AM
Find all posts by this user Quote this message in a reply
TheElk Offline
Member

Post: #14
RE: Documentation
Esenthel

Just want to say thank you for updating the documentation, It will help a lot.


TheElk
02-08-2014 11:23 AM
Visit this user's website Find all posts by this user Quote this message in a reply
yasei_no_otoko Offline
Member

Post: #15
RE: Documentation
This is wonderful! Thank you!
However, since it is too dreary, let's use a code highlight. smile

http://highlightjs.org
02-08-2014 05:36 PM
Find all posts by this user Quote this message in a reply
Post Reply