git404hub

what is documentation fr?

raspberrypi/documentation — explained in plain English

Analysis updated 2026-06-26

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

tl;dr

The source files and build tools for the official Raspberry Pi documentation website, written in AsciiDoc, contribute corrections here and the published guides at raspberrypi.com/documentation are updated.

vibe map

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

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

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

VIBE 2

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

VIBE 3

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

VIBE 4

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

what's the stack?

PythonAsciiDoc

how it stacks up fr

raspberrypi/documentationbeancount/beancountcchen156/learning-to-see-in-the-dark
Stars5,5655,5695,561
LanguagePythonPythonPython
Setup difficultymoderatemoderatehard
Complexity1/52/55/5
Audiencegeneralgeneralresearcher

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

how do i run it?

Difficulty · moderate time til it works · 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.

in plain english

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.

prompts (copy fr)

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

what is documentation fr?

The source files and build tools for the official Raspberry Pi documentation website, written in AsciiDoc, contribute corrections here and the published guides at raspberrypi.com/documentation are updated.

What language is documentation written in?

Mainly Python. The stack also includes Python, AsciiDoc.

What license does documentation use?

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

How hard is documentation to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is documentation for?

Mainly general.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.