About the docs

How to contribute to Raku and to the documents, how to generate the docs locally

This document collection represents the on-going effort to document the Raku programming language with the goals of being comprehensive, easy to use, easy to navigate, and useful to both newcomers and experienced Raku programmers.

An HTML version of the documentation is available.

The official source for this documentation is located at Raku/doc on GitHub.

Structure§

All of the documentation is written in Raku Pod and kept in the doc/ directory. These files are processed are rendered to HTML, and also processed into some generated pages, using the .rakudoc files as sources.

Generating HTML from Pod§

The build process is managed through a separate repository, Raku/doc-website on GitHub.

Contributing§

For a quick introduction to Raku Pod, see Raku Pod.

For historic details about the Raku Pod specification, see Synopsis 26, Documentation.

For information on how to contribute to the documentation, please read CONTRIBUTING.md.