CodeScene
=========

.. rubric:: Welcome to the CodeScene documentation!

This documentation is divided into sections, each being suited for different
types of information you might be looking for.

New Users
---------

* :doc:`getting-started/index` helps you take the first steps after you
  purchase of CodeScene. You will learn how to install and
  setup the tool, as well as running your first analysis.
* :doc:`terminology/codescene-terminology` explains the concepts, analysis options, and
  metrics.

From Code to Delivery: meet the 4-factors of successful software
----------------------------------------------------------------

* :doc:`4f-dashboard/4-factors-dashboard` introduces the 4 factors essential to
  successful software development. We explain how the dashboards work and how you
  set up team specific dashboards.

Developer tools
---------------
* :doc:`guides/pr-integration/integrate-into-ci-cd` speeds up code reviews and ensures your code remains maintainable.
* The :doc:`cli/index` is a command-line tool which performs the same checks as the PR integration, but locally - on non-committed, staged changes or between select branches. Check the link for setup instructions. **Note:** Requires a user with a Technical role - see :doc:`configuration/users-and-roles`.
* :doc:`guides/code-coverage-gates/check-code-coverage-in-pull-and-merge-requests` to enforce code coverage where it matters most.
* :doc:`auto-refactor/index` is CodeScene's innovative Generative AI solution which allows you to automatically fix code smells. Integrates with your IDE as well as the :doc:`cli/index`.  

Usage Documentation
-------------------

* :doc:`integrations/index` explains how you integrate CodeScene with CI/CD to
  enable quality gates, upload and visualize of code coverage, integrations with project management tools to
  measure lead times in your development process, or Slack for analysis notifications.
* :doc:`guides/index` walk you through specific features and aspects of the
  tool, focusing on how you can use them to achieve certain goals.
* :doc:`configuration/index` explains how you configure projects to get the
  most out of your analysis.
* :doc:`getting-started/troubleshooting-diagnostics-errors-and-logs` contains helpful tips for troubleshooting the system.

CodeScene supports all major programming languages:

* :doc:`usage/language-support` covers CodeScene's language level support.

New CodeScene releases are available continuously. 
Stay on top of the latest releases by subscribing to our Release Notes `here <https://community.codescene.com/changelog>`_ .

.. toctree::
  :hidden:

  getting-started/index
  terminology/codescene-terminology
  4f-dashboard/4-factors-dashboard
  cli/index
  auto-refactor/index
  integrations/index
  guides/index
  configuration/index
  usage/language-support
  getting-started/troubleshooting-diagnostics-errors-and-logs

