0 Fork 0

mirror of https://github.com/llvm/llvm-project.git synced 2026-10-26 13:53:31 +08:00

Files

T

Reid Kleckner 3e414a36cd [docs] Migrate 22 popular LLVM docs to MyST (#201244 )

This was done with LLM assistance.

I rebuilt the LLVM docs, opened all 22 docs in a browser and scrolled
through them, and caught and fixed a few errors.

Tracking issue: #201242 
Migration guide docs:
https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines
RFC:
https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/90840

2026-06-22 16:02:50 -07:00

1.2 KiB

Raw Permalink Blame History

Getting Started/Tutorials

For those new to the LLVM system.

:hidden:

CompilerWriterInfo
Frontend/PerformanceTips
GettingStarted
GettingStartedVS
ProgrammersManual
DebuggingLLVM
tutorial/index
MyFirstTypoFix

{doc}GettingStarted: Discusses how to get up and running quickly with the LLVM infrastructure. Everything from unpacking and compilation of the distribution to execution of some tools.
{doc}tutorial/index: Tutorials about using LLVM. Includes a tutorial about making a custom language with LLVM.
{doc}ProgrammersManual: Introduction to the general layout of the LLVM sourcebase, important classes and APIs, and some tips & tricks.
{doc}DebuggingLLVM: Provides information about how to debug LLVM.
{doc}Frontend/PerformanceTips: A collection of tips for frontend authors on how to generate IR which LLVM is able to effectively optimize.
{doc}GettingStartedVS: An addendum to the main Getting Started guide for those using Visual Studio on Windows.
{doc}CompilerWriterInfo: A list of helpful links for compiler writers.
{doc}MyFirstTypoFix: This tutorial will guide you through the process of making a change to LLVM, and contributing it back to the LLVM project.

1.2 KiB Raw Permalink Blame History

Getting Started/Tutorials

1.2 KiB

Raw Permalink Blame History