mirror of
https://github.com/godotengine/godot-website.git
synced 2026-01-04 06:09:55 +03:00
Deploying to published from @ godotengine/godot-website@d66c9f9b03 🚀
This commit is contained in:
Godot Organization
File diff suppressed because one or more lines are too long
6
atom.xml
6
atom.xml
@@ -1,4 +1,4 @@
|
||||
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom"><title>Godot Engine Official</title><link href="https://godotengine.org/atom.xml" rel="self"/><link href="https://godotengine.org/"/><updated>2025-09-18T12:25:06+00:00</updated><id>https://godotengine.org/</id><entry><title>Ensuring quality in the Godot documentation, a continuous process</title><link href="https://godotengine.org/article/ensuring-quality-godot-documentation/"/><updated>2025-09-18T14:00:00+00:00</updated><id>https://godotengine.org/article/ensuring-quality-godot-documentation/</id><summary>The Godot documentation is the fruits of the labor of hundreds of people working together. How do we ensure the highest possible level of quality, while making it easy for anyone to contribute? Find out in this article.</summary><content type="html"><p>What makes up the quality and usability of an open-source project is not just about its code. A big part of what makes a project useful to the community is its documentation.</p>
|
||||
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom"><title>Godot Engine Official</title><link href="https://godotengine.org/atom.xml" rel="self"/><link href="https://godotengine.org/"/><updated>2025-09-18T13:28:30+00:00</updated><id>https://godotengine.org/</id><entry><title>Ensuring quality in the Godot documentation, a continuous process</title><link href="https://godotengine.org/article/ensuring-quality-godot-documentation/"/><updated>2025-09-18T14:00:00+00:00</updated><id>https://godotengine.org/article/ensuring-quality-godot-documentation/</id><summary>The Godot documentation is the fruits of the labor of hundreds of people working together. How do we ensure the highest possible level of quality, while making it easy for anyone to contribute? Find out in this article.</summary><content type="html"><p>What makes up the quality and usability of an open-source project is not just about its code. A big part of what makes a project useful to the community is its documentation.</p>
|
||||
<p>Over the years, Godot contributors have developed many tools and processes to ensure the highest possible level of quality for the <a href="https://docs.godotengine.org/">documentation</a>. Read on if you’re curious about how the documentation is made.</p>
|
||||
<h2 id="documentation-repository-organization">Documentation repository organization</h2>
|
||||
<p>Godot’s documentation is hosted on <a href="https://about.readthedocs.com/">Read the Docs</a>. This service provides hosting for projects using <a href="https://www.sphinx-doc.org/">Sphinx</a>, which is a static site generator targeted at building documentation.</p>
|
||||
@@ -53,7 +53,7 @@
|
||||
<li><a href="https://godotengine.github.io/doc-status/"><strong>Godot class reference status</strong></a></li>
|
||||
</ul>
|
||||
<p>This website relies on the <a href="https://github.com/godotengine/godot/blob/master/doc/tools/make_rst.py"><code class="language-plaintext highlighter-rouge">make_rst.py</code></a> script from the main Godot repository, which detects the completion percentage and outputs a Markdown table with the results.</p>
|
||||
<p>Being aware of the overall and per-class completion percentages at all times made it a lot easier to improve the documentation coverage. As of writing, the overall completion percentage is <strong>97%</strong>. With additional efforts from <a href="https://docs.godotengine.org/en/stable/contributing/documentation/updating_the_class_reference.html">contributors like you</a>, we can perhaps reach 100% completion in the future.</p>
|
||||
<p>Being aware of the overall and per-class completion percentages at all times made it a lot easier to improve the documentation coverage. As of writing, the overall completion percentage is <strong>97%</strong>. With additional efforts from <a href="https://contributing.godotengine.org/en/latest/documentation/class_reference.html">contributors like you</a>, we can perhaps reach 100% completion in the future.</p>
|
||||
<p><img alt="Godot class reference status website screenshot" src="/storage/blog/ensuring-quality-godot-documentation/doc-status.webp" /></p>
|
||||
<h2 id="team-reports-for-class-reference-pull-requests">Team reports for class reference pull requests</h2>
|
||||
<p>Another way for contributors to organize pull requests and work through the backlog is to use the <em>team reports</em> website. This website was built for contributors to check all open pull requests in a more convenient fashion than using GitHub’s web interface. Using this website, it’s easier to see when pull requets were last active and whether they are in a mergeable state (which may not be the case due to merge conflicts).</p>
|
||||
@@ -76,7 +76,7 @@
|
||||
<p>As a bonus, you can also watch the <a href="https://github.com/godotengine/godot-docs-user-notes">godot-docs-user-notes</a> repository on GitHub to be informed of new user notes being added to documentation pages. Replying to user notes left by others is a good way to get started with documentation improvements, as many user notes bring new information that can be incorporated into the main page.</p>
|
||||
<h2 id="conclusion">Conclusion</h2>
|
||||
<p>This organization allows more people to contribute in various ways, even with limited technical know-how. Not only does the documentation benefit from those opening <a href="github.com/godotengine/godot-docs/pulls">pull requests</a>, it’s also continuously improved every day by those posting user notes at the bottom of documentation pages. These user notes bring further clarifications and context to the manual pages, as well as linking to useful resources.</p>
|
||||
<p>A massive <strong>thank you</strong> to <a href="https://github.com/godotengine/godot-docs/graphs/contributors">all contributors to the documentation</a>! As always, we welcome contributions to the documentation. <a href="https://docs.godotengine.org/en/stable/contributing/documentation/index.html">The contribution process is well-documented</a>, but you’re welcome to hop on the <a href="https://chat.godotengine.org">Godot contributors chat</a>’s <code class="language-plaintext highlighter-rouge">#documentation</code> channel if you have any questions.</p>
|
||||
<p>A massive <strong>thank you</strong> to <a href="https://github.com/godotengine/godot-docs/graphs/contributors">all contributors to the documentation</a>! As always, we welcome contributions to the documentation. <a href="https://contributing.godotengine.org/en/latest/documentation/overview.html">The contribution process is well-documented</a>, but you’re welcome to hop on the <a href="https://chat.godotengine.org">Godot contributors chat</a>’s <code class="language-plaintext highlighter-rouge">#documentation</code> channel if you have any questions.</p>
|
||||
<h2 id="support">Support</h2>
|
||||
<p>If you would like to help with the development of these features, please consider <a href="https://fund.godotengine.org/">supporting the project financially</a>! More funding allows us to sponsor volunteer contributors and better respond to technical demands of project users.</p></content><author><name>Hugo Locurcio</name></author><category term="News"/></entry><entry><title>Godot 4.5, making dreams accessible</title><link href="https://godotengine.org/article/godot-4-5-making-dreams-accessible/"/><updated>2025-09-15T20:00:00+00:00</updated><id>https://godotengine.org/article/godot-4-5-making-dreams-accessible/</id><summary>From mind-blowing effects now made possible by the stencil buffer to accessibilty descriptions of your GUI elements that opens up the possibility for some with disabilities to play your game — we are proud to present to you Godot 4.5.</summary><content type="html"/><author><name>Godot contributors</name></author><category term="Release"/></entry><entry><title>Release candidate: Godot 4.5 RC 2</title><link href="https://godotengine.org/article/release-candidate-godot-4-5-rc-2/"/><updated>2025-09-10T12:00:00+00:00</updated><id>https://godotengine.org/article/release-candidate-godot-4-5-rc-2/</id><summary>One more for the road, again!</summary><content type="html"><p>On Friday of last week, we dropped our first <a href="https://en.wikipedia.org/wiki/Software_release_life_cycle#Release_candidate">Release Candidate</a> build. As a reminder, we release RC builds once we <em>think</em> the engine has stabilized and is ready for release. It is your last chance to report critical regressions before we release the stable version. Now, not even a full week later, we’re ready with our second snapshot. This RC2 fixes the last of the critical regressions that we are aware of. Unless someone reports a new regression coming from the changes made in RC1 or RC2, we should be on track to release 4.5 stable soon.</p>
|
||||
<p>At this point in the process you will see the activity on GitHub slow down as we avoid merging work for 4.5. Our focus in the coming days will be on preparing the release, and queuing up all the changes we would like to merge early in the 4.6 release cycle.</p>
|
||||
|
||||
4
rss.xml
4
rss.xml
@@ -53,7 +53,7 @@
|
||||
<li><a href="https://godotengine.github.io/doc-status/"><strong>Godot class reference status</strong></a></li>
|
||||
</ul>
|
||||
<p>This website relies on the <a href="https://github.com/godotengine/godot/blob/master/doc/tools/make_rst.py"><code class="language-plaintext highlighter-rouge">make_rst.py</code></a> script from the main Godot repository, which detects the completion percentage and outputs a Markdown table with the results.</p>
|
||||
<p>Being aware of the overall and per-class completion percentages at all times made it a lot easier to improve the documentation coverage. As of writing, the overall completion percentage is <strong>97%</strong>. With additional efforts from <a href="https://docs.godotengine.org/en/stable/contributing/documentation/updating_the_class_reference.html">contributors like you</a>, we can perhaps reach 100% completion in the future.</p>
|
||||
<p>Being aware of the overall and per-class completion percentages at all times made it a lot easier to improve the documentation coverage. As of writing, the overall completion percentage is <strong>97%</strong>. With additional efforts from <a href="https://contributing.godotengine.org/en/latest/documentation/class_reference.html">contributors like you</a>, we can perhaps reach 100% completion in the future.</p>
|
||||
<p><img alt="Godot class reference status website screenshot" src="/storage/blog/ensuring-quality-godot-documentation/doc-status.webp" /></p>
|
||||
<h2 id="team-reports-for-class-reference-pull-requests">Team reports for class reference pull requests</h2>
|
||||
<p>Another way for contributors to organize pull requests and work through the backlog is to use the <em>team reports</em> website. This website was built for contributors to check all open pull requests in a more convenient fashion than using GitHub’s web interface. Using this website, it’s easier to see when pull requets were last active and whether they are in a mergeable state (which may not be the case due to merge conflicts).</p>
|
||||
@@ -76,7 +76,7 @@
|
||||
<p>As a bonus, you can also watch the <a href="https://github.com/godotengine/godot-docs-user-notes">godot-docs-user-notes</a> repository on GitHub to be informed of new user notes being added to documentation pages. Replying to user notes left by others is a good way to get started with documentation improvements, as many user notes bring new information that can be incorporated into the main page.</p>
|
||||
<h2 id="conclusion">Conclusion</h2>
|
||||
<p>This organization allows more people to contribute in various ways, even with limited technical know-how. Not only does the documentation benefit from those opening <a href="github.com/godotengine/godot-docs/pulls">pull requests</a>, it’s also continuously improved every day by those posting user notes at the bottom of documentation pages. These user notes bring further clarifications and context to the manual pages, as well as linking to useful resources.</p>
|
||||
<p>A massive <strong>thank you</strong> to <a href="https://github.com/godotengine/godot-docs/graphs/contributors">all contributors to the documentation</a>! As always, we welcome contributions to the documentation. <a href="https://docs.godotengine.org/en/stable/contributing/documentation/index.html">The contribution process is well-documented</a>, but you’re welcome to hop on the <a href="https://chat.godotengine.org">Godot contributors chat</a>’s <code class="language-plaintext highlighter-rouge">#documentation</code> channel if you have any questions.</p>
|
||||
<p>A massive <strong>thank you</strong> to <a href="https://github.com/godotengine/godot-docs/graphs/contributors">all contributors to the documentation</a>! As always, we welcome contributions to the documentation. <a href="https://contributing.godotengine.org/en/latest/documentation/overview.html">The contribution process is well-documented</a>, but you’re welcome to hop on the <a href="https://chat.godotengine.org">Godot contributors chat</a>’s <code class="language-plaintext highlighter-rouge">#documentation</code> channel if you have any questions.</p>
|
||||
<h2 id="support">Support</h2>
|
||||
<p>If you would like to help with the development of these features, please consider <a href="https://fund.godotengine.org/">supporting the project financially</a>! More funding allows us to sponsor volunteer contributors and better respond to technical demands of project users.</p></description><category>News</category><guid>https://godotengine.org/article/ensuring-quality-godot-documentation/</guid><dc:creator>Hugo Locurcio</dc:creator><pubDate>Thu, 18 Sep 2025 14:00:00 +0000</pubDate><image>https://godotengine.org/storage/blog/covers/ensuring-quality-godot-documentation.webp</image></item><item><title>Godot 4.5, making dreams accessible</title><link>https://godotengine.org/article/godot-4-5-making-dreams-accessible/</link><summary>From mind-blowing effects now made possible by the stencil buffer to accessibilty descriptions of your GUI elements that opens up the possibility for some with disabilities to play your game — we are proud to present to you Godot 4.5.</summary><description/><category>Release</category><guid>https://godotengine.org/article/godot-4-5-making-dreams-accessible/</guid><dc:creator>Godot contributors</dc:creator><pubDate>Mon, 15 Sep 2025 20:00:00 +0000</pubDate><image>https://godotengine.org/storage/blog/covers/godot-4-5-making-dreams-accessible.webp?cache=v2</image></item><item><title>Release candidate: Godot 4.5 RC 2</title><link>https://godotengine.org/article/release-candidate-godot-4-5-rc-2/</link><summary>One more for the road, again!</summary><description><p>On Friday of last week, we dropped our first <a href="https://en.wikipedia.org/wiki/Software_release_life_cycle#Release_candidate">Release Candidate</a> build. As a reminder, we release RC builds once we <em>think</em> the engine has stabilized and is ready for release. It is your last chance to report critical regressions before we release the stable version. Now, not even a full week later, we’re ready with our second snapshot. This RC2 fixes the last of the critical regressions that we are aware of. Unless someone reports a new regression coming from the changes made in RC1 or RC2, we should be on track to release 4.5 stable soon.</p>
|
||||
<p>At this point in the process you will see the activity on GitHub slow down as we avoid merging work for 4.5. Our focus in the coming days will be on preparing the release, and queuing up all the changes we would like to merge early in the 4.6 release cycle.</p>
|
||||
|
||||
Reference in New Issue
Block a user