docs/index.rst

.. image:: https://i.imgur.com/3yj1n6N.png

|
**NodeBB** is a next-generation discussion platform that utilizes web sockets for instant interactions and real-time notifications. NodeBB forums have many modern features out of the box such as social network integration and streaming discussions.

NodeBB is an open source project which can be forked on `GitHub <https://github.com/NodeBB/NodeBB/>`_. Don't forget to check out the ways that you can help contribute to this project, from translations, pull requests, and telling your friends.

Table of Contents
=================

.. _installing:

Installing NodeBB
-----------------

.. toctree::
   :maxdepth: 2

   installing/os
   installing/cloud


.. _configuring:

Configuring NodeBB
------------------

.. toctree::
    :maxdepth: 2

    configuring/databases
    configuring/proxies

Running NodeBB
------------------

.. toctree::
    :maxdepth: 2

    running/index

Upgrading NodeBB
------------------

.. toctree::
    :maxdepth: 2

    upgrading/index

Administrating NodeBB
---------------------

.. toctree::
    :maxdepth: 2

    admin/outline
    admin/sso
    admin/uploads

Contributing to NodeBB
----------------------

.. toctree::
    :maxdepth: 2

    contributing/style-guide
    modules/index

Plugin System
-------------

.. toctree::
    :maxdepth: 2

    plugins/create
    plugins/hooks
    plugins/settings

Widgets System
--------------

.. toctree::
    :maxdepth: 2

    widgets/create

Theming Engine
--------------

.. toctree::
    :maxdepth: 2

    themes/create
    themes/templates


Developer's Resources
---------------------

.. toctree::
    :maxdepth: 2

    resources

Helping out the NodeBB Project
------------------------------

.. toctree::
    :maxdepth: 2

    helping/index

Troubleshooting / Help
----------------------

.. toctree::
    :maxdepth: 2

    help/help

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
updated nodebb logo to https 2014-04-30 14:50:46 -04:00			`.. image:: https://i.imgur.com/3yj1n6N.png`
init sphinx docs 2014-04-24 15:56:20 -04:00
docs index page 2014-04-24 16:54:11 -04:00			`\|`
added ToC and more description to intro 2014-04-25 17:39:58 -04:00			`NodeBB is a next-generation discussion platform that utilizes web sockets for instant interactions and real-time notifications. NodeBB forums have many modern features out of the box such as social network integration and streaming discussions.`

update all docs with new url 2014-05-23 15:21:36 -04:00			NodeBB is an open source project which can be forked on `GitHub <https://github.com/NodeBB/NodeBB/>`_. Don't forget to check out the ways that you can help contribute to this project, from translations, pull requests, and telling your friends.
added ToC and more description to intro 2014-04-25 17:39:58 -04:00
			`Table of Contents`
			`=================`
init sphinx docs 2014-04-24 15:56:20 -04:00
more documentation, man reST hurts my brain 2014-04-24 17:17:11 -04:00			`.. _installing:`

docs index page 2014-04-24 16:54:11 -04:00			`Installing NodeBB`
			`-----------------`
init sphinx docs 2014-04-24 15:56:20 -04:00
			`.. toctree::`
			`:maxdepth: 2`

okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00			`installing/os`
			`installing/cloud`
more documentation, man reST hurts my brain 2014-04-24 17:17:11 -04:00

			`.. _configuring:`

			`Configuring NodeBB`
			`------------------`

			`.. toctree::`
			`:maxdepth: 2`
init sphinx docs 2014-04-24 15:56:20 -04:00
okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00			`configuring/databases`
			`configuring/proxies`

forgot to port "how to run nodebb" 2014-04-28 17:01:32 -04:00			`Running NodeBB`
			`------------------`

			`.. toctree::`
			`:maxdepth: 2`

			`running/index`

converted upgrading steps, also added to backup section (todo: mongo) 2014-04-28 16:58:16 -04:00			`Upgrading NodeBB`
			`------------------`

			`.. toctree::`
			`:maxdepth: 2`

			`upgrading/index`

okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00			`Administrating NodeBB`
			`---------------------`

			`.. toctree::`
			`:maxdepth: 2`

			`admin/outline`
			`admin/sso`
completed the skeleton files for all the docs 2014-04-24 17:40:30 -04:00			`admin/uploads`
okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00
			`Contributing to NodeBB`
			`----------------------`

			`.. toctree::`
			`:maxdepth: 2`

			`contributing/style-guide`
modules documentation - alerts 2014-05-10 16:16:35 -04:00			`modules/index`
okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00
			`Plugin System`
			`-------------`

			`.. toctree::`
			`:maxdepth: 2`

			`plugins/create`
init plugins documentation 2014-04-25 19:09:40 -04:00			`plugins/hooks`
Added settings-framework documentation 2014-05-04 12:37:49 +02:00			`plugins/settings`
okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00
			`Widgets System`
			`--------------`

			`.. toctree::`
			`:maxdepth: 2`

			`widgets/create`

			`Theming Engine`
			`--------------`

			`.. toctree::`
			`:maxdepth: 2`

			`themes/create`
			`themes/templates`


got rid of the separate resources sections and combined into one developer's resources 2014-04-26 17:23:33 -04:00			`Developer's Resources`
			`---------------------`

			`.. toctree::`
			`:maxdepth: 2`

			`resources`

okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00			`Helping out the NodeBB Project`
			`------------------------------`

			`.. toctree::`
			`:maxdepth: 2`

helping out the nodebb project section 2014-04-28 16:32:13 -04:00			`helping/index`
okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00
minor changes to docs 2014-04-24 17:44:20 -04:00			`Troubleshooting / Help`
			`----------------------`
okay... wrote an index for help and organized stuff. lets do this! 2014-04-24 17:29:53 -04:00
			`.. toctree::`
			`:maxdepth: 2`

			`help/help`
init sphinx docs 2014-04-24 15:56:20 -04:00
			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`