Documentation's TOC

[maxiride]

Here follows my concept of the docs TOC with appropriate nesting of the subjects to deal with. The "Let's Play!" is intended as almost a step-by-step\hand-by-hand turorial with extensive examples and proper explanation of what is happening under the hood.

The real TOC name is the part before the :, after that I added a brief explanation of what I intend for each section but it's not meant to end up in the TOC indexing.

I'm fully open to suggestions. As I'm about to go out I'll explain in a more "verbose" manner each part and why I think it's the proper organization in a future comment.

---

1. Home: Brief introduction to the framework

2. Let's Play!: (section for "newbies")

   1. Introduction: Scope of this section of the docs, knowledge prerequisites - opposed to what is taken for granted in the Core section

   2. Environment: Must have stuff and its usage plus suggested software and Overview of the files and the structure of the framework

   3. Registering your bot: Botfather, its usage and options

   4. First steps with the code:

      1. getUpdates: analysis of the file, and what each part does, initial configuration with bot credentials and MySQL database for local use in vagrant
      2. Overview of the example commands: self-explanatory
      3. Creating a custom command: self-explanatory
      4. Testing the bot: experimenting with the example commands and custom commands locally
      5. Webhook: what it is and how it works
         1. set.php
            1. unset.php
         2. hook.php
         3. manager.php
         4. notes on self signed certificates

3. Core

   1. Overview of the methods and the classes available
      1. Types
      2. Methods
      3. Inline Query
   2. Utilities
      1. MySQL
      2. Channel integration
      3. Botan.io
   3. Commands
      1. Predefined commands
      2. Custom commands
      3. Commands configuration
      4. Admin Commands
         1. Set admins
         2. Channel Administration
            1. Upload and Download paths and usage of the calls to up\down stuff
            2. Logging

[noplanman]

General TOC looks good so far, will have a deeper think into this the coming week.

What we also need to decide, is what will go into the wiki and what into the documentation, if they merge or certain things kept separate.

[maxiride]

What we also need to decide, is what will go into the wiki and what into the documentation, if they merge or certain things kept separate.

I think that keeping all in the same place helps in consistency and avoid confusion for the users. If anyone has a question there should be only one place where to look for it — before asking with an issue or the telegram chat.

A new section could be added to the previously listed index, where everyone can freely create new pages without worrying of "ruining" the docs aspects. I mean that a PR that affects the main index need to be carefully checked for coherence with the rest of the docs — not being repetitive, well written, formatted etc; a new page under the free for all section could instead be merged almost instantly.

[maxiride]

I'm removing ii.a,b,c,d in favour of a one-for-all chapter about the environment explained as an overall overview of what is happening.

The Vagrantfile I've prepared will perform all such steps for a more plug-n-play usage of the example-bot.

---

Removed:

• Environment: Must have stuff and its usage plus suggested software
  • Vagrant setup and usage
  • Composer setup and usage
  • MySQL setup and first initialization with the structure.sql
  • Git clone the example-bot and brief overview of the files and the structure of the framework