Files
godot-docs/tutorials/editor/index.rst
Hugo Locurcio 95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00

81 lines
2.1 KiB
ReStructuredText

:allow_comments: False
:article_outdated: True
Editor introduction
===================
In this section, we cover the Godot editor in general, from its interface to
using it with the command line.
Editor's interface
------------------
The following pages explain how to use the various windows, workspaces, and
docks that make up the Godot editor. We cover some specific editors' interface
in other sections where appropriate. For example, the :ref:`animation editor
<doc_introduction_animation>`.
.. toctree::
:maxdepth: 1
:name: toc-editor-interface
project_manager
inspector_dock
project_settings
default_key_mapping
customizing_editor
Android editor
--------------
Godot offers a native port of the editor running entirely on Android devices.
The Android port can be downloaded from the `Android Downloads page <https://godotengine.org/download/android/>`__.
While we strive for feature parity with the Desktop version of the editor,
the Android port has a certain amount of caveats you should be aware of.
.. toctree::
:maxdepth: 1
:name: toc-android-editor
using_the_android_editor
Web editor
----------
Godot offers an HTML5 version of the editor running entirely in your browser. No
download is required to use it, but it has a certain amount of caveats you
should be aware of.
.. toctree::
:maxdepth: 1
:name: toc-web-editor
using_the_web_editor
Advanced features
-----------------
The articles below focus on advanced features useful for experienced developers,
such as calling Godot from the command line and using an external text editor
like Visual Studio Code or Emacs.
.. toctree::
:maxdepth: 1
:name: toc-learn-editor
command_line_tutorial
external_editor
Managing editor features
------------------------
Godot allows you to remove features from the editor. This may be useful if you're
an educator trying to ease students into the editor slowly, or if you're working on
a project that's only 2D or only 3D and don't want to see what you don't need.
.. toctree::
:maxdepth: 1
:name: toc-editor-features
managing_editor_features