What is documentation?

raspberrypi/documentation — explained in plain English

Analysis updated 2026-06-26

★ 5,565PythonAudience · generalComplexity · 1/5LicenseSetup · moderate

Mindmap

mindmap
  root((repo))
    What it does
      Generates docs website
      Manages source files
      Accepts contributions
    Content format
      AsciiDoc text files
      Build tools convert
      Publishes to website
    Licensing
      CC BY-SA 4.0 content
      BSD 3-Clause tooling
    Audience
      Documentation editors
      Raspberry Pi users
      Educators

mindmap root((repo)) What it does Generates docs website Manages source files Accepts contributions Content format AsciiDoc text files Build tools convert Publishes to website Licensing CC BY-SA 4.0 content BSD 3-Clause tooling Audience Documentation editors Raspberry Pi users Educators

Click or tap to explore — scroll the page freely

What do people build with it?

USE CASE 1

Propose corrections or additions to official Raspberry Pi documentation by submitting a pull request.

USE CASE 2

Reuse and adapt Raspberry Pi documentation content in your own educational materials under CC BY-SA terms.

USE CASE 3

Run the build tools locally to preview your documentation changes before submitting them.

USE CASE 4

Study the AsciiDoc structure and build pipeline for generating a large technical documentation website.

What is it built with?

PythonAsciiDoc

How does it compare?

	raspberrypi/documentation	beancount/beancount	cchen156/learning-to-see-in-the-dark
Stars	5,565	5,569	5,561
Language	Python	Python	Python
Setup difficulty	moderate	moderate	hard
Complexity	1/5	2/5	5/5
Audience	general	general	researcher

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Documentation content uses CC BY-SA 4.0, build tooling uses BSD 3-Clause, run local build tools to preview changes.

Content is free to reuse and adapt as long as you credit the source and share changes under the same Creative Commons terms.

So what is it?

This repository holds the source files and build tools for the official Raspberry Pi documentation website. Raspberry Pi is a line of small, affordable computers and microcontrollers made by a UK nonprofit, commonly used for learning electronics, building projects, and teaching programming. The repository itself is not the documentation you read, but rather the raw files and scripts used to generate the published website at raspberrypi.com/documentation. The actual content is written in AsciiDoc, a text-based format for structured documents, and a set of tools in this repository converts those files into the final website pages. The README for this repository is sparse. It points to the live documentation site for anyone who wants to read the guides, and to a contributing guide for anyone who wants to propose corrections or additions. The documentation content is licensed under Creative Commons Attribution-ShareAlike 4.0, meaning it can be reused and adapted as long as credit is given and the result is shared under the same terms. The build tooling is licensed separately under the BSD 3-Clause license.

Copy-paste prompts

Prompt 1

How do I contribute a correction to the official Raspberry Pi documentation by forking this repository?

Prompt 2

How do I build the Raspberry Pi documentation website locally from the AsciiDoc source files?

Prompt 3

I want to reuse Raspberry Pi documentation in my own guide. What are the CC BY-SA 4.0 attribution requirements?

Prompt 4

How is the AsciiDoc source organized in this repository, and which files control the site navigation?

Frequently asked questions