Raspberry Pi Documentation Local Wiki
Use the local official Raspberry Pi Documentation corpus before web sources. Optimize for source-backed answers with bounded output and local path citations.
Corpus profile
- Local checkout path:
~/.raspberrypiwiki
- Indexed source: official
raspberrypi/documentation repository, primarily documentation/asciidoc/
- Parser/format: AsciiDoc
- Indexed extensions:
.adoc, .asciidoc, .asc
- Setup command:
/raspberrypi-wiki-local-setup
- Smoke test:
/raspberrypi_wiki-smoke-test or raspberrypi_wiki_smoke_test({ maxSearchResults: 5 })
The repository contains source files used to build the public Raspberry Pi Documentation site. It also has build/tooling Markdown files; the local wiki intentionally indexes only AsciiDoc documentation files to avoid build-doc noise in support searches.
Confidence target
Aim for 90-95/100 confidence by combining local documentation evidence, exact section citations, read-only local evidence when relevant, and explicit caveats when docs/output are incomplete.
If confidence is below 90/100, improve it by searching a second wording, listing sections, extracting exact sections, checking related pages, checking official online docs for freshness, or asking for missing hardware/OS details.
Required workflow
- Start with
raspberrypi_wiki_search({ query, limit: 5, includeSnippets: false }).
- If the page is large or aggregate-like, run
raspberrypi_wiki_sections({ page, maxSections: 40-80 }).
- Prefer exact section extraction for final evidence:
raspberrypi_wiki_extract({ page, section, maxChars: 4000-8000, maxSections: 2-5 })
- Use query extraction only for exploration, then switch to exact headings when available.
- Use
raspberrypi_wiki_read({ page, maxChars }) only for broad context or when no relevant heading is identifiable.
- Use
raspberrypi_wiki_related({ page, limit: 5-10 }) when the issue spans linked topics.
- Run read-only local diagnostics when system/project evidence is relevant.
- Compare documentation guidance with observed local state.
- Cite local paths and section names in final answers.
- Ask before destructive, persistent, hardware-risk, or user-facing changes.
Search hints
Use specific Raspberry Pi terms and current tool names:
- SSH/headless:
ssh headless setup, raspi-config ssh, imager remote access.
- Camera:
rpicam libcamera picamera2, rpicam options, camera_auto_detect, camera module.
- Boot/config:
config.txt dtoverlay dtparam, cmdline.txt, device tree overlay.
- GPIO:
gpio pinout pinctrl, 40-pin header, raspi-gpio.
- Storage/boot:
nvme boot pi 5, usb boot, bootloader eeprom BOOT_ORDER.
- Network/remote desktop:
wifi networkmanager nmcli, vnc, raspberry pi connect.
- Pico/microcontrollers:
pico sdk blink, rp2040, rp2350, micropython.
- Accessories/HATs: include the product name, e.g.
sense hat, ai camera, m.2 hat+.
Source priority
- Local Raspberry Pi Documentation corpus via
raspberrypi_wiki_* tools.
- Local project/system evidence relevant to the user's current Raspberry Pi or host environment.
- Official online Raspberry Pi Documentation/GitHub only when local docs are missing, stale, or insufficient.
- Other sources only when necessary and clearly labeled.
Tool usage
raspberrypi_wiki_search({ query, limit, includeSnippets }): find candidate pages. Keep limit at 5 unless exploring broadly; snippets default off.
raspberrypi_wiki_sections({ page, maxSections }): inspect headings before extracting from large pages.
raspberrypi_wiki_extract({ page, section, maxChars, maxSections }): retrieve focused exact sections; best for final answers.
raspberrypi_wiki_extract({ page, query, maxChars, maxSections }): retrieve query-relevant sections; best for exploration.
raspberrypi_wiki_read({ page, maxChars }): retrieve broad page text; use sparingly.
raspberrypi_wiki_related({ page, limit }): discover linked local pages.
raspberrypi_wiki_smoke_test({ maxSearchResults }): verify parser/search/extract/read/related behavior after package or corpus updates.
Diagnostics policy
Prefer read-only commands first and only run commands relevant to the user's issue/environment. Useful Raspberry Pi diagnostics include:
uname -a
tr -d '\0' </proc/device-tree/model 2>/dev/null || cat /proc/device-tree/model 2>/dev/null || true
cat /etc/os-release
vcgencmd version 2>/dev/null || true
vcgencmd get_throttled 2>/dev/null || true
command -v raspi-config >/dev/null && raspi-config nonint get_config_var arm_64bit /boot/firmware/config.txt 2>/dev/null || true
grep -RsnE '^(dtoverlay|dtparam|camera_auto_detect|display_auto_detect|arm_64bit|boot_order|program_usb_boot_mode)' /boot/config.txt /boot/firmware/config.txt 2>/dev/null || true
ip -brief addr 2>/dev/null || true
systemctl status ssh --no-pager 2>/dev/null || true
lsblk -f 2>/dev/null || true
For Pico/Pico SDK work, prefer read-only project checks first:
cmake --version 2>/dev/null || true
python3 --version 2>/dev/null || true
printenv PICO_SDK_PATH PICO_TOOLCHAIN_PATH 2>/dev/null || true
find . -maxdepth 3 -name CMakeLists.txt -o -name pico_sdk_import.cmake 2>/dev/null
Safety policy
Ask before mutation, especially:
- Editing
/boot/firmware/config.txt, /boot/config.txt, /boot/firmware/cmdline.txt, EEPROM/bootloader configuration, NetworkManager profiles, or system services.
- Running
rpi-eeprom-update, rpi-update, firmware flashing, SD-card/USB/NVMe imaging, partitioning, formatting, or boot-order changes.
- Installing/removing packages, enabling remote access, changing passwords/SSH keys, or exposing services to a network.
- GPIO, HAT, camera, display, or power-supply wiring changes. Tell the user to power down before physical wiring changes when appropriate.
Do not assume non-Raspberry-Pi Linux hosts behave like Raspberry Pi OS. Verify model, OS release, boot path, and relevant commands first.
Token/output discipline
- Keep search limits small (
limit: 5-10) and leave snippets off unless they are needed.
- Prefer
search -> sections -> exact section extract for final answers.
- Use query extraction only to discover likely sections on large pages.
- Use
maxChars around 4000-8000 and maxSections around 2-5 for focused answers.
- Use
read only when the relevant section cannot be identified.
- If a tool reports
omittedSectionCount or truncated: true, mention it when it affects confidence.
Citation format
Use local source citations like:
Sources:
- ~/.raspberrypiwiki/documentation/asciidoc/computers/remote-access/ssh.adoc — Enable the SSH server
- ~/.raspberrypiwiki/documentation/asciidoc/computers/raspberry-pi/boot-nvme.adoc — NVMe SSD boot
1---2name: raspberrypi-local3description: Use automatically for Raspberry Pi computers, Raspberry Pi OS, Raspberry Pi Imager, raspi-config, config.txt/cmdline.txt, GPIO, HATs/accessories, camera/rpicam/libcamera/Picamera2, SSH/VNC/Connect, bootloader/EEPROM/NVMe/USB boot, Compute Module, Pico/RP2040/RP2350/Pico SDK/MicroPython, and Raspberry Pi documentation questions. Prefer local Raspberry Pi Documentation evidence via raspberrypi_wiki tools before web sources.4metadata:5 source: https://skillmd.com/skills/firstp1ck/raspberrypi-local6---78# Raspberry Pi Documentation Local Wiki910Use the local official Raspberry Pi Documentation corpus before web sources. Optimize for source-backed answers with bounded output and local path citations.1112## Corpus profile1314- Local checkout path: `~/.raspberrypiwiki`15- Indexed source: official `raspberrypi/documentation` repository, primarily `documentation/asciidoc/`16- Parser/format: AsciiDoc17- Indexed extensions: `.adoc`, `.asciidoc`, `.asc`18- Setup command: `/raspberrypi-wiki-local-setup`19- Smoke test: `/raspberrypi_wiki-smoke-test` or `raspberrypi_wiki_smoke_test({ maxSearchResults: 5 })`2021The repository contains source files used to build the public Raspberry Pi Documentation site. It also has build/tooling Markdown files; the local wiki intentionally indexes only AsciiDoc documentation files to avoid build-doc noise in support searches.2223## Confidence target2425Aim for **90-95/100 confidence** by combining local documentation evidence, exact section citations, read-only local evidence when relevant, and explicit caveats when docs/output are incomplete.2627If confidence is below 90/100, improve it by searching a second wording, listing sections, extracting exact sections, checking related pages, checking official online docs for freshness, or asking for missing hardware/OS details.2829## Required workflow30311. Start with `raspberrypi_wiki_search({ query, limit: 5, includeSnippets: false })`.322. If the page is large or aggregate-like, run `raspberrypi_wiki_sections({ page, maxSections: 40-80 })`.333. Prefer exact section extraction for final evidence:34 - `raspberrypi_wiki_extract({ page, section, maxChars: 4000-8000, maxSections: 2-5 })`354. Use query extraction only for exploration, then switch to exact headings when available.365. Use `raspberrypi_wiki_read({ page, maxChars })` only for broad context or when no relevant heading is identifiable.376. Use `raspberrypi_wiki_related({ page, limit: 5-10 })` when the issue spans linked topics.387. Run read-only local diagnostics when system/project evidence is relevant.398. Compare documentation guidance with observed local state.409. Cite local paths and section names in final answers.4110. Ask before destructive, persistent, hardware-risk, or user-facing changes.4243## Search hints4445Use specific Raspberry Pi terms and current tool names:4647- SSH/headless: `ssh headless setup`, `raspi-config ssh`, `imager remote access`.48- Camera: `rpicam libcamera picamera2`, `rpicam options`, `camera_auto_detect`, `camera module`.49- Boot/config: `config.txt dtoverlay dtparam`, `cmdline.txt`, `device tree overlay`.50- GPIO: `gpio pinout pinctrl`, `40-pin header`, `raspi-gpio`.51- Storage/boot: `nvme boot pi 5`, `usb boot`, `bootloader eeprom BOOT_ORDER`.52- Network/remote desktop: `wifi networkmanager nmcli`, `vnc`, `raspberry pi connect`.53- Pico/microcontrollers: `pico sdk blink`, `rp2040`, `rp2350`, `micropython`.54- Accessories/HATs: include the product name, e.g. `sense hat`, `ai camera`, `m.2 hat+`.5556## Source priority57581. Local Raspberry Pi Documentation corpus via `raspberrypi_wiki_*` tools.592. Local project/system evidence relevant to the user's current Raspberry Pi or host environment.603. Official online Raspberry Pi Documentation/GitHub only when local docs are missing, stale, or insufficient.614. Other sources only when necessary and clearly labeled.6263## Tool usage6465- `raspberrypi_wiki_search({ query, limit, includeSnippets })`: find candidate pages. Keep `limit` at 5 unless exploring broadly; snippets default off.66- `raspberrypi_wiki_sections({ page, maxSections })`: inspect headings before extracting from large pages.67- `raspberrypi_wiki_extract({ page, section, maxChars, maxSections })`: retrieve focused exact sections; best for final answers.68- `raspberrypi_wiki_extract({ page, query, maxChars, maxSections })`: retrieve query-relevant sections; best for exploration.69- `raspberrypi_wiki_read({ page, maxChars })`: retrieve broad page text; use sparingly.70- `raspberrypi_wiki_related({ page, limit })`: discover linked local pages.71- `raspberrypi_wiki_smoke_test({ maxSearchResults })`: verify parser/search/extract/read/related behavior after package or corpus updates.7273## Diagnostics policy7475Prefer read-only commands first and only run commands relevant to the user's issue/environment. Useful Raspberry Pi diagnostics include:7677```bash78uname -a79tr -d '\0' </proc/device-tree/model 2>/dev/null || cat /proc/device-tree/model 2>/dev/null || true80cat /etc/os-release81vcgencmd version 2>/dev/null || true82vcgencmd get_throttled 2>/dev/null || true83command -v raspi-config >/dev/null && raspi-config nonint get_config_var arm_64bit /boot/firmware/config.txt 2>/dev/null || true84grep -RsnE '^(dtoverlay|dtparam|camera_auto_detect|display_auto_detect|arm_64bit|boot_order|program_usb_boot_mode)' /boot/config.txt /boot/firmware/config.txt 2>/dev/null || true85ip -brief addr 2>/dev/null || true86systemctl status ssh --no-pager 2>/dev/null || true87lsblk -f 2>/dev/null || true88```8990For Pico/Pico SDK work, prefer read-only project checks first:9192```bash93cmake --version 2>/dev/null || true94python3 --version 2>/dev/null || true95printenv PICO_SDK_PATH PICO_TOOLCHAIN_PATH 2>/dev/null || true96find . -maxdepth 3 -name CMakeLists.txt -o -name pico_sdk_import.cmake 2>/dev/null97```9899## Safety policy100101Ask before mutation, especially:102103- Editing `/boot/firmware/config.txt`, `/boot/config.txt`, `/boot/firmware/cmdline.txt`, EEPROM/bootloader configuration, NetworkManager profiles, or system services.104- Running `rpi-eeprom-update`, `rpi-update`, firmware flashing, SD-card/USB/NVMe imaging, partitioning, formatting, or boot-order changes.105- Installing/removing packages, enabling remote access, changing passwords/SSH keys, or exposing services to a network.106- GPIO, HAT, camera, display, or power-supply wiring changes. Tell the user to power down before physical wiring changes when appropriate.107108Do not assume non-Raspberry-Pi Linux hosts behave like Raspberry Pi OS. Verify model, OS release, boot path, and relevant commands first.109110## Token/output discipline111112- Keep search limits small (`limit: 5-10`) and leave snippets off unless they are needed.113- Prefer `search -> sections -> exact section extract` for final answers.114- Use query extraction only to discover likely sections on large pages.115- Use `maxChars` around 4000-8000 and `maxSections` around 2-5 for focused answers.116- Use `read` only when the relevant section cannot be identified.117- If a tool reports `omittedSectionCount` or `truncated: true`, mention it when it affects confidence.118119## Citation format120121Use local source citations like:122123```txt124Sources:125- ~/.raspberrypiwiki/documentation/asciidoc/computers/remote-access/ssh.adoc — Enable the SSH server126- ~/.raspberrypiwiki/documentation/asciidoc/computers/raspberry-pi/boot-nvme.adoc — NVMe SSD boot127```