[llvm-branch-commits] [llvm] [docs] Migrate 22 popular LLVM docs to MyST (PR #201244)

Wed Jun 3 13:51:38 PDT 2026

================
@@ -1,137 +1,121 @@
-.. _developer_policy:
+(developer_policy)=
+# LLVM Developer Policy
 
-=====================
-LLVM Developer Policy
-=====================
+```{contents}
+:local:
+```
 
-.. contents::
-   :local:
-
-Introduction
-============
+## Introduction
 
 This document contains the LLVM Developer Policy which defines the project's
 policy towards developers and their contributions. The intent of this policy is
 to eliminate miscommunication, rework, and confusion that might arise from the
-distributed nature of LLVM's development.  By stating the policy in clear terms,
+distributed nature of LLVM's development. By stating the policy in clear terms,
 we hope each developer can know ahead of time what to expect when making LLVM
-contributions.  This policy covers all llvm.org subprojects, including Clang,
+contributions. This policy covers all llvm.org subprojects, including Clang,
 LLDB, libc++, MLIR, etc.
 
 The developer policy supports the following LLVM project objectives:
 
-#. Attract both users and new contributors to the LLVM project.
-
-#. Help people contribute to LLVM by documenting our development practices.
-
-#. Maintain the stability, performance, and quality of the ``main`` branch.
+1. Attract both users and new contributors to the LLVM project.
+2. Help people contribute to LLVM by documenting our development practices.
+3. Maintain the stability, performance, and quality of the `main` branch.
+4. Establish the project's {ref}`copyright, license, and patent
+    policies <copyright-license-patents>` policies.
 
-#. Establish the project's :ref:`copyright, license, and patent
-   policies <copyright-license-patents>` policies.
+## Developer Policies
 
-Developer Policies
-==================
-
-Communication Channels
-----------------------
+### Communication Channels
 
 LLVM is a large project with many subcomponents, and it has a wide array of
 communication channels that you can use to keep track of recent developments,
 upcoming projects, new designs, enhancements, and other community business.
 
-First and foremost is the `LLVM Discourse forums`_, which is the successor
-to our former mailing lists (llvm-dev@, cfe-dev@, lldb-dev@, etc). This is
-probably the most vital and active communication channel to our highly
-distributed open source project. It enables long-form asynchronous text
-communication, and this is where people tend to propose major changes or
-propose new designs in the form of RFCs (Request For Comment), which are
-described later. Please be aware that the Discourse forums are public and
+First and foremost is the [LLVM Discourse forums](https://discourse.llvm.org),
+which is the successor to our former mailing lists (llvm-dev@, cfe-dev@,
+lldb-dev@, etc). This is probably the most vital and active communication
+channel to our highly distributed open source project. It enables long-form
+asynchronous text communication, and this is where people tend to propose major
+changes or propose new designs in the form of RFCs (Request For Comment), which
+are described later. Please be aware that the Discourse forums are public and
 archived, and that notices of confidentiality or non-disclosure cannot be
 respected.
 
-We accept code contributions as :ref:`GitHub Pull Requests <github-reviews>`.
+We accept code contributions as {ref}`GitHub Pull Requests <github-reviews>`.
 Our project is generally too large to subscribe to all github notifications, so
 if you want to be notified of pull requests affecting specific parts of the
-code, you can join
-one of the `pr-subscribers-* <https://github.com/orgs/llvm/teams?query=pr-subscribers>`_
-GitHub teams. This `mapping <https://github.com/llvm/llvm-project/blob/main/.github/new-prs-labeler.yml>`_
+code, you can join one of the
+[pr-subscribers-\*](https://github.com/orgs/llvm/teams?query=pr-subscribers)
+GitHub teams. This
+[mapping](https://github.com/llvm/llvm-project/blob/main/.github/new-prs-labeler.yml)
 documents the paths that trigger notifications for each of the listed teams.
 
-Missing features and bugs are tracked through our `GitHub issue tracker
-<https://github.com/llvm/llvm-project/issues>`_. You can subscribe for
-notification for specific components by joining one of the `issue-subscribers-*
-<https://github.com/orgs/llvm/teams?query=issue-subscribers>`_ teams. You may
-also subscribe to the `llvm-bugs
-<http://lists.llvm.org/mailman/listinfo/llvm-bugs>`_ email list to subscribe to
-the firehose of all issue notifications, which some community members use to
-perform custom filtering.
+Missing features and bugs are tracked through our [GitHub issue
+tracker](https://github.com/llvm/llvm-project/issues). You can subscribe for
+notification for specific components by joining one of the
+[issue-subscribers-\*](https://github.com/orgs/llvm/teams?query=issue-subscribers)
+teams. You may also subscribe to the
+[llvm-bugs](http://lists.llvm.org/mailman/listinfo/llvm-bugs) email list to
+subscribe to the firehose of all issue notifications, which some community
+members use to perform custom filtering.
 
 Beyond the asynchronous written communication channels, LLVM has a Discord
 server for real-time chat communication, as well as a community calendar with
-many regular workgroup video calls and office hours. See :doc:`GettingInvolved`
+many regular workgroup video calls and office hours. See {doc}`GettingInvolved`
 for more information on other ways to engage with the community.
 
-.. _patch:
-
-Making and Submitting a Patch
------------------------------
+(patch)=
+### Making and Submitting a Patch
 
 Patches are submitted to GitHub and reviewed using Pull Requests. Follow the
-:ref:`Getting Started Guide <sources>` to check out sources, make a patch, and
-then follow the :ref:`GitHub Pull Request <github-reviews>` guide to upload a
+{ref}`Getting Started Guide <sources>` to check out sources, make a patch, and
+then follow the {ref}`GitHub Pull Request <github-reviews>` guide to upload a
 pull request.
 
 Here are some tips to enable a successful code review:
 
-* :ref:`Include a test <include a testcase>`. This tends to be one of the first
-  things a reviewer will ask for and look at to understand what a new patch
-  does.
-
-* Identify 2-3 individuals to review the patch. Look through the relevant
-  :ref:`Maintainers` file or browse git blame for likely stakeholders for the
-  code you want to modify, and add ``@username`` to a PR comment to notify them
-  of your PR if you are unable to add reviewers yourself due to GitHub permissions.
-
-* To avoid precommit CI failures due to merge conflicts, base your patches on a
-  recent commit from ``main``. If you want to make changes to a release branch,
-  land a change in ``main`` first and then follow the
-  :ref:`backporting instructions <backporting>`.
-
-See :doc:`CodeReview` for more info on what to expect.
+- {ref}`Include a test <include a testcase>`. This tends to be one of the
+first things a reviewer will ask for and look at to understand what a new patch
+does.
+- Identify 2-3 individuals to review the patch. Look through the relevant
+    {ref}`Maintainers` file or browse git blame for likely stakeholders for the
+    code you want to modify, and add `@username` to a PR comment to notify them
+    of your PR if you are unable to add reviewers yourself due to GitHub
+    permissions.
+- To avoid precommit CI failures due to merge conflicts, base your patches on
+    a recent commit from `main`. If you want to make changes to a release
+    branch, land a change in `main` first and then follow the {ref}`backporting
+    instructions <backporting>`.
+
+See {doc}`CodeReview` for more info on what to expect.
 
 When submitting patches, please do not add confidentiality or non-disclosure
-notices to the patches themselves.  These notices conflict with the LLVM
+notices to the patches themselves. These notices conflict with the LLVM
----------------
rnk wrote:

I did a pass to try to correct the indentation and I fixed a few of these, but I don't have a good automated solution for this. I'm not too worried about single-space whitespace changes, `git diff -w` does a decent job looking through these changes.

https://github.com/llvm/llvm-project/pull/201244
