Mojo documentation

This directory includes most of the documentation at docs.modular.com/mojo.

The only things not here are the mojo CLI pages and the Mojo Standard Library reference. The reference docs are generated from source files, which are located in the /stdlib/std directory.

Contributing

If you see something in the docs that is wrong or could be improved, we'd love to accept your contributions.

If your change is any one of the following simple changes, please create a pull request and we will happily accept it as quickly as possible:

• Typo fix
• Markup/rendering fix
• Factual information fix
• New factual information for an existing page

Before embarking on other major changes, please create an issue or start a discussion, so we can collaborate and agree on a solution. For example, adding an entire new page to the documentation is a lot of work and it might conflict with other work that’s already in progress. We don’t want you to spend time on something that might require difficult reviews and rework, or that might get rejected.

Be aware that we don't provide tools to generate a preview of the website, because the Mojo docs are built along with other content that's not included in this repo. As such, we recommend you preview your edits in an IDE that can render Markdown and MDX files, such as VS Code, including the VS Code environment in GitHub.

For more information about how to contribute, see the Contributor Guide

Other docs

• /mojo/stdlib/docs: Docs for developers working in the Mojo standard library.
• /max/docs: Docs for developers working in the MAX framework codebase.
• /max/docs/design-docs: Engineering docs that describe how core Modular technologies work.
• docs.modular.com: All other developer docs.