Merge pull request #6817 from YuriSizov/web-mark-4.0-status

Add a warning that docs are WIP and a status flag for articles

_static/css/custom.css

@@ -936,11 +936,24 @@ code,
 }
 
 /* Admonition tweaks */
+.rst-content .admonition-grid {
+    display: grid;
+    grid-template-columns: 4fr 5fr;
+    gap: 20px;
+}
+@media screen and (max-width: 1020px) {
+    .rst-content .admonition-grid {
+        grid-template-columns: 1fr;
+        gap: 12px;
+    }
+}
 
 .rst-content .admonition,
 .rst-content .admonition.note,
 .rst-content .admonition.seealso {
     background-color: var(--admonition-note-background-color);
+    border-radius: 4px;
+    box-shadow: 0px 3px 9px 0px rgb(0 0 0 / 29%);
     color: var(--admonition-note-color);
 }
 
@@ -948,7 +961,17 @@ code,
 .rst-content .admonition.note .admonition-title,
 .rst-content .admonition.seealso .admonition-title {
     background-color: var(--admonition-note-title-background-color);
+    border-radius: 4px 4px 0 0;
     color: var(--admonition-note-title-color);
+    font-weight: 600;
+    font-size: 105%;
+    line-height: 120%;
+    padding: 6px 16px;
+    text-align: right;
+}
+
+.rst-content .admonition .admonition-title:before {
+    margin-right: 9px;
 }
 
 .rst-content .admonition.attention,
@@ -987,6 +1010,10 @@ code,
     color: var(--admonition-tip-title-color);
 }
 
+.article-status strong {
+    color: var(--body-color);
+}
+
 /* Keyboard shortcuts tweaks */
 kbd, .kbd,
 .rst-content :not(dl.option-list) > :not(dt):not(kbd):not(.kbd) > kbd,

_templates/layout.html

@@ -26,17 +26,41 @@
 
 {%- block document %}
 <div itemprop="articleBody">
-  {% if godot_is_latest %}
-  <div class="admonition attention latest-notice">
-    <p class="first admonition-title">Attention</p>
-    <p>
-      You are reading the <code class="docutils literal notranslate"><span class="pre">latest</span></code>
-      (unstable) version of this documentation, which may document features not available
-      or compatible with Godot 3.x.
-    </p>
-    <p class="last latest-notice-link">
-      Checking the stable version of the documentation...
-    </p>
+  {% if godot_is_latest or godot_show_article_status %}
+  <div class="admonition-grid">
+    {% if godot_is_latest %}
+    <div class="admonition attention latest-notice">
+      <p class="first admonition-title">Attention</p>
+      <p>
+        You are reading the <code class="docutils literal notranslate"><span class="pre">latest</span></code>
+        (unstable) version of this documentation, which may document features not available
+        or compatible with Godot 3.x.
+      </p>
+      <p class="last latest-notice-link">
+        Checking the stable version of the documentation...
+      </p>
+    </div>
+    {% endif %}
+
+    {% if godot_show_article_status %}
+    <div class="admonition tip article-status">
+      <p class="first admonition-title">Work in progress</p>
+      <p>
+        Godot documentation is being updated to reflect the latest changes in version
+        <code class="docutils literal notranslate">{{ godot_version }}</code>. Some documentation pages may
+        still state outdated information. This banner will tell you if you're reading one of such pages.
+      </p>
+      <p>
+        {% if meta and meta.get('article_outdated') == 'True' %}
+          The contents of this page can be <strong>outdated</strong>. If you know how to improve this page or you can confirm
+          that it's up to date, feel free to <a href="https://github.com/godotengine/godot-docs">open a pull request</a>.
+        {% else %}
+          The contents of this page are <strong>up to date</strong>. If you can still find outdated information, please
+          <a href="https://github.com/godotengine/godot-docs">open an issue</a>.
+        {% endif %}
+      </p>
+    </div>
+    {% endif %}
   </div>
   {% endif %}
 

about/docs_changelog.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_docs_changelog:
 
 Documentation changelog

about/release_policy.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_release_policy:
 
 Godot release policy

about/troubleshooting.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_troubleshooting:
 
 Troubleshooting

conf.py

@@ -178,6 +178,9 @@ html_context = {
     # Set this to `True` when in the `latest` branch to clearly indicate to the reader
     # that they are not reading the `stable` documentation.
     "godot_is_latest": True,
+    "godot_version": "4.0",
+    # Enables a banner that displays the up-to-date status of each article.
+    "godot_show_article_status": True,
 }
 
 html_logo = "img/docs_logo.svg"
@@ -192,14 +195,14 @@ html_extra_path = ["robots.txt"]
 html_css_files = [
     'css/algolia.css',
     'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css',
-    "css/custom.css?7", # Increment the number at the end when the file changes to bust the cache.
+    "css/custom.css?8", # Increment the number at the end when the file changes to bust the cache.
 ]
 
 if not on_rtd:
     html_css_files.append("css/dev.css")
 
 html_js_files = [
-    "js/custom.js?4", # Increment the number at the end when the file changes to bust the cache.
+    "js/custom.js?5", # Increment the number at the end when the file changes to bust the cache.
     ('https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js', {'defer': 'defer'}),
     ('js/algolia.js', {'defer': 'defer'})
 ]

contributing/development/file_formats/gdscript_grammar.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_gdscript_grammar:
 
 GDScript grammar

contributing/development/file_formats/tscn.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_tscn_file_format:
 
 TSCN file format

getting_started/introduction/godot_design_philosophy.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_godot_design_philosophy:
 
 Godot's design philosophy

getting_started/introduction/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. Intention: provide the necessary information to make the most of the getting
    started series, answering questions like "do I want to learn Godot?", "how
    does it look and feel?", "how does it work?", and "how do I best learn it?".

getting_started/introduction/introduction_to_godot.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_introduction_to_godot:
 
 Introduction to Godot

getting_started/introduction/key_concepts_overview.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. Intention: introduce only a handful of key concepts and avoid a big cognitive
    load. Readers will then be reminded of the concepts further in the getting
    started series, reinforcing their learning.

getting_started/introduction/learning_new_features.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. Keep this page short and sweet! We want users to read it to the end, so they
    know where to find information, how to get help, and how to maximize chances
    of getting answers.

getting_started/step_by_step/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Step by step
 ============
 

getting_started/step_by_step/instancing.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_instancing:
 
 Creating instances

getting_started/step_by_step/nodes_and_scenes.rst

@@ -1,4 +1,7 @@
-.. The goal of this page is to explain more than doc_key_concepts_overview about nodes and scenes, get the user to create their first concrete scene.
+:article_outdated: True
+
+.. The goal of this page is to explain more than doc_key_concepts_overview about nodes and scenes,
+   get the user to create their first concrete scene.
 
 .. _doc_nodes_and_scenes:
 

getting_started/step_by_step/scripting_first_script.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 ..
     Intention:
 

getting_started/step_by_step/scripting_languages.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. Intention: only introduce what a script does in general and options for
    scripting languages.
 

getting_started/step_by_step/scripting_player_input.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. Intention: only introduce one necessary input method at this point. The
    Inputs section of the docs should provide more guides comparing the various
    tools you have to manage the complexity of user input.

getting_started/step_by_step/signals.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. Intention: give the user a first taste of signals. We should write more
    documentation in the scripting/ section.
 .. Note: GDScript snippets use one line return instead of two because they're

tutorials/2d/2d_meshes.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_2d_meshes:
 
 2D meshes

tutorials/2d/2d_transforms.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_viewport_and_canvas_transforms:
 
 Viewport and canvas transforms

tutorials/2d/particle_systems_2d.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_particle_systems_2d:
 
 Particle systems (2D)

tutorials/2d/using_tilemaps.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_using_tilemaps:
 
 Using TileMaps

tutorials/3d/csg_tools.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_csg_tools:
 
 Prototyping levels with CSG

tutorials/3d/high_dynamic_range.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_high_dynamic_range:
 
 High dynamic range lighting

tutorials/3d/using_multi_mesh_instance.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_using_multi_mesh_instance:
 
 Using MultiMeshInstance3D

tutorials/animation/animation_track_types.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_animation_track_types:
 
 Animation Track types

tutorials/audio/audio_buses.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_audio_buses:
 
 Audio buses

tutorials/audio/audio_effects.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_audio_effects:
 
 Audio effects

tutorials/audio/audio_streams.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_audio_streams:
 
 Audio streams

tutorials/audio/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Audio
 =====
 

tutorials/audio/recording_with_microphone.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_recording_with_microphone:
 
 Recording with microphone

tutorials/audio/sync_with_audio.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_sync_with_audio:
 
 Sync the gameplay with audio and music

tutorials/best_practices/autoloads_versus_internal_nodes.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_autoloads_versus_internal_nodes:
 
 Autoloads versus regular nodes

tutorials/best_practices/data_preferences.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_data_preferences:
 
 Data preferences

tutorials/best_practices/godot_interfaces.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_godot_interfaces:
 
 Godot interfaces

tutorials/best_practices/godot_notifications.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_godot_notifications:
 
 Godot notifications

tutorials/best_practices/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Best practices
 ==============
 

tutorials/best_practices/introduction_best_practices.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_introduction_best_practices:
 
 Introduction

tutorials/best_practices/logic_preferences.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_logic_preferences:
 
 Logic preferences

tutorials/best_practices/node_alternatives.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_node_alternatives:
 
 When and how to avoid using nodes for everything

tutorials/best_practices/scene_organization.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_scene_organization:
 
 Scene organization

tutorials/best_practices/scenes_versus_scripts.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_scenes_versus_scripts:
 
 When to use scenes versus scripts

tutorials/best_practices/version_control_systems.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_version_control_systems:
 
 Version Control Systems

tutorials/best_practices/what_are_godot_classes.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_what_are_godot_classes:
 
 Applying object-oriented principles in Godot

tutorials/editor/command_line_tutorial.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_command_line_tutorial:
 
 Command line tutorial

tutorials/editor/customizing_editor.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_customizing_editor:
 
 Customizing the interface

tutorials/editor/default_key_mapping.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. meta::
     :keywords: cheatsheet, cheat sheet, shortcut
 

tutorials/editor/external_editor.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_external_editor:
 
 Using an external text editor

tutorials/editor/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Editor introduction
 ===================
 

tutorials/editor/inspector_dock.rst

@@ -1,3 +1,4 @@
+:article_outdated: True
 
 .. _doc_editor_inspector_dock:
 

tutorials/editor/managing_editor_features.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_managing_editor_features:
 
 Managing editor features

tutorials/editor/project_manager.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_project_manager:
 
 Using the Project manager

tutorials/editor/project_settings.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_project_settings:
 
 Project Settings

tutorials/editor/using_the_web_editor.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_using_the_web_editor:
 
 Using the Web editor

tutorials/export/exporting_for_dedicated_servers.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_exporting_for_dedicated_servers:
 
 Exporting for dedicated servers

tutorials/export/exporting_for_uwp.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_exporting_for_uwp:
 
 Exporting for Universal Windows Platform

tutorials/export/exporting_projects.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_exporting_projects:
 
 Exporting projects

tutorials/io/background_loading.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_background_loading:
 
 Background loading

tutorials/io/binary_serialization_api.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_binary_serialization_api:
 
 Binary serialization API

tutorials/networking/high_level_multiplayer.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_high_level_multiplayer:
 
 High-level multiplayer

tutorials/networking/http_client_class.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_http_client_class:
 
 HTTP client class

tutorials/networking/http_request_class.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_http_request_class:
 
 Making HTTP requests

tutorials/networking/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Networking
 ==========
 

tutorials/networking/ssl_certificates.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_ssl_certificates:
 
 SSL certificates

tutorials/networking/webrtc.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_webrtc:
 
 WebRTC

tutorials/networking/websocket.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_websocket:
 
 WebSocket

tutorials/performance/cpu_optimization.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_cpu_optimization:
 
 CPU optimization

tutorials/performance/general_optimization.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_general_optimization:
 
 General optimization tips

tutorials/performance/gpu_optimization.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_gpu_optimization:
 
 GPU optimization

tutorials/performance/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_performance:
 
 Performance

tutorials/performance/optimizing_3d_performance.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. meta::
     :keywords: optimization
 

tutorials/performance/thread_safe_apis.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_thread_safe_apis:
 
 Thread-safe APIs

tutorials/performance/using_multimesh.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_using_multimesh:
 
 Optimization using MultiMeshes

tutorials/performance/using_multiple_threads.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_using_multiple_threads:
 
 Using multiple threads

tutorials/performance/using_servers.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_using_servers:
 
 Optimization using Servers

tutorials/performance/vertex_animation/animating_thousands_of_fish.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_animating_thousands_of_fish:
 
 Animating thousands of fish with MultiMeshInstance3D

tutorials/performance/vertex_animation/controlling_thousands_of_fish.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_controlling_thousands_of_fish:
 
 Controlling thousands of fish with Particles

tutorials/performance/vertex_animation/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Animating thousands of objects
 ==============================
 

tutorials/platform/android/android_in_app_purchases.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_android_in_app_purchases:
 
 Android in-app purchases

tutorials/platform/android/android_plugin.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_android_plugin:
 
 Creating Android plugins

tutorials/platform/android/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Android plugins
 ===============
 

tutorials/platform/customizing_html5_shell.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_customizing_html5_shell:
 
 Custom HTML page for Web export

tutorials/platform/html5_shell_classref.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_html5_shell_classref:
 
 HTML5 shell class reference

tutorials/platform/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 Platform-specific
 =================
 

tutorials/platform/ios/index.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 iOS plugins
 ===========
 

tutorials/platform/ios/ios_plugin.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_ios_plugin:
 
 Creating iOS plugins

tutorials/platform/ios/plugins_for_ios.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_plugins_for_ios:
 
 Plugins for iOS

tutorials/platform/platform_html5.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_platform_html5:
 
 HTML5

tutorials/plugins/editor/3d_gizmos.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_3d_gizmo_plugins:
 
 3D gizmo plugins

tutorials/plugins/editor/import_plugins.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_import_plugins:
 
 Import plugins

tutorials/plugins/editor/making_main_screen_plugins.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_making_main_screen_plugins:
 
 Making main screen plugins

tutorials/rendering/multiple_resolutions.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_multiple_resolutions:
 
 Multiple resolutions

tutorials/ui/custom_gui_controls.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_custom_gui_controls:
 
 Custom GUI controls

tutorials/ui/gui_containers.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_gui_containers:
 
 Using Containers

tutorials/ui/size_and_anchors.rst

@@ -1,3 +1,5 @@
+:article_outdated: True
+
 .. _doc_size_and_anchors:
 
 Size and anchors