<commit_before>Welcome to CS Unplugged
#######################################

.. warning::

  This repository (including this documentation) is currently in development!
  Therefore features may not be implemented yet, may change, be buggy, or completely broken.

.. toctree::
    :maxdepth: 2
    :caption: Contents
    :titlesonly:

    installation
    getting_started/index
    author/index
    developer/index<commit_msg>Add landing page for documentation<commit_after>Welcome to CS Unplugged
##############################################################################

.. warning::

  This repository (including this documentation) is currently in development!
  Therefore features may not be implemented yet, may change, be buggy, or
  completely broken.

Welcome to the documentation for the CS Unplugged project.
The documentation is split into the following sections:

------------------------------------------------------------------------------

:doc:`Installation Documentation <installation>`
==============================================================================

This documentation is used for getting the project installed on your system.

------------------------------------------------------------------------------

:doc:`Getting Started Documentation <getting_started/index>`
==============================================================================

This documentation will help you understand how the project is setup, and
basic steps on how to use it.

------------------------------------------------------------------------------

:doc:`Author Documentation <author/index>`
==============================================================================

This documentation is for those who want to help write content for the CS
Unplugged project, specifically text content.
This is the place to start if you plan to add or modify topic content (for
example: clear up instructions on a lesson), or add translations.

------------------------------------------------------------------------------

:doc:`Developer Documentation <developer/index>`
==============================================================================

This documentation is for those who want to contribute to developing the
Django system for delivering the CS Unplugged content.
This includes everything from HTML templates used to render webpages,
Python scripts to generate custom PDF resources, test suites for checking
database models, and URL routing of views.

------------------------------------------------------------------------------

.. toctree::
    :maxdepth: 3
    :caption: Table of Contents

    installation
    getting_started/index
    author/index
    developer/index
{'fraction_non_alphanumeric': 0.3377630121816168, 'fraction_numerical': 0.0007382798080472499, 'mean_word_length': 2.618157543391188, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1962498', 'n_tokens_mistral': 527, 'n_tokens_neox': 481, 'n_words': 234}