docs

Mojo standard library documentation

This documentation is for you if you're contributing to the Mojo standard library. For example, if you're adding or changing stdlib APIs, fixing bugs, or working through the codebase for the first time, start here.

Table of contents

• development.md—Mojo standard library development: Set up your environment, fork and branch, build the library and run tests. Start here if you're new to contributing.

• style-guide.md—Coding standards and style guide: Conventions for stdlib code: file layout, mojo format, naming, value lifecycle, API docstrings, and how to validate docstrings.

• docstring-style-guide.md—Mojo docstring style guide: How to write API docs (docstrings) in Mojo: voice and tone, named sections (including Safety:), formatting rules, and per-declaration-level conventions for packages, modules, types, fields, aliases, and functions.

• faq.md—Frequently asked questions: Contributor-focused FAQ for the standard library (platform support, bug reporting, MLIR dialects, compiler runtime).

• adding-gpu-targets.md—Adding a new GPU target: Contributor guide for extending std/gpu/host/info.mojo with a new GPU architecture, covering the MLIR target configuration and the data_layout string format.

Other docs

• oss/modular/mojo/docs: Mojo user documentation (published at https://www.mojolang.org).
• /max/docs: Docs for developers working in the MAX framework.
• /max/docs/design-docs: Engineering docs that describe how core Modular technologies work.
• max.modular.com: All other developer docs.