Skip to content

CE #2674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 28, 2022
Merged

CE #2674

Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions documentation/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,26 @@
"default_tab": "yes",
"subitems": [
{
"title": "Getting Started",
"description": "This is the stuff about how to get started",
"title": "Getting started",
"description": "How to get started with your Raspberry Pi",
"image": "full-sized/Getting-Started.png",
"subpath": "getting-started.adoc"
},
{
"title": "Raspberry Pi OS",
"description": "The official OS of Raspberry Pi",
"description": "The official Raspberry Pi operating system",
"image": "full-sized/Raspberry-Pi-OS.png",
"subpath": "os.adoc"
},
{
"title": "Configuration",
"description": "Configuring the Raspberry Pi's settings to suit your needs",
"description": "Configuring your Raspberry Pi's settings",
"image": "full-sized/Configuration.png",
"subpath": "configuration.adoc"
},
{
"title": "The config.txt file",
"description": "Low-level control of your Raspberry Pi's settings",
"description": "Low-level settings control",
"image": "full-sized/The-config-txt-file.png",
"subpath": "config_txt.adoc"
},
Expand All @@ -36,19 +36,19 @@
"subpath": "linux_kernel.adoc"
},
{
"title": "Remote Access",
"title": "Remote access",
"description": "Accessing your Raspberry Pi remotely",
"image": "full-sized/Remote-Access.png",
"subpath": "remote-access.adoc"
},
{
"title": "Raspberry Pi Hardware",
"title": "Raspberry Pi hardware",
"description": "Technical information about Raspberry Pi hardware",
"image": "full-sized/Raspberry-Pi-Hardware.png",
"subpath": "raspberry-pi.adoc"
},
{
"title": "Compute Module Hardware",
"title": "Compute Module hardware",
"description": "Technical information about Raspberry Pi Compute Module hardware",
"image": "full-sized/Compute-Module-Hardware.png",
"subpath": "compute-module.adoc"
Expand All @@ -60,14 +60,14 @@
"subpath": "processors.adoc"
},
{
"title": "PIP",
"description": "The Product Information Portal (PIP) for Raspberry Pi compliance documents",
"title": "Product Information Portal",
"description": "Raspberry Pi compliance documents",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the intention for PIP to (eventually) be more than just compliance documents?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Eventually, most of what's on datasheets.raspberrypi.com will but put into PIP. But not before it's overhauled to get human-readable URLs and allow us to use human-readable document names. A string of numbers and letters which you have to go and look up isn't helpful. Documents should have human-readable names.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The names are automatically generated by Cognidox. Not sure there is a way round that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, but PIP isn't raw Cognidox. Paul and Chris are going to look at it.

"image": "full-sized/PIP.png",
"url": "https://pip.raspberrypi.com/"
},
{
"title": "Datasheets",
"description": "The Datasheets site for PDF-based documentation",
"description": "PDF documentation",
"image": "full-sized/Datasheets.png",
"url": "https://datasheets.raspberrypi.com"
},
Expand All @@ -92,7 +92,7 @@
"subitems": [
{
"title": "Camera",
"description": "We have several Raspberry Pi cameras",
"description": "Raspberry Pi camera boards",
"image": "full-sized/Camera.png",
"subpath": "camera.adoc"
},
Expand All @@ -103,8 +103,8 @@
"subpath": "display.adoc"
},
{
"title": "Keyboard & Mouse",
"description": "We have our own keyboard and mouse",
"title": "Keyboard and mouse",
"description": "Official Raspberry Pi keyboard and mouse",
"image": "full-sized/Keyboard-and-Mouse.png",
"subpath": "keyboard-and-mouse.adoc"
},
Expand All @@ -128,7 +128,7 @@
},
{
"title": "Raspberry Pi Audio",
"description": "Our range of audio HATs",
"description": "High-definition audio with Raspberry Pi",
"image": "full-sized/Audio-HATs.png",
"subpath": "audio.adoc"
},
Expand All @@ -139,14 +139,14 @@
"url": "https://github.com/raspberrypi/hats"
},
{
"title": "PIP",
"description": "The Product Information Portal (PIP) for Raspberry Pi compliance documents",
"title": "Product Information Portal",
"description": "Raspberry Pi compliance documents",
"image": "full-sized/PIP.png",
"url": "https://pip.raspberrypi.com/"
},
{
"title": "Datasheets",
"description": "The Datasheets site for PDF-based documentation",
"description": "PDF-based documentation",
"image": "full-sized/Datasheets.png",
"url": "https://datasheets.raspberrypi.com"
},
Expand All @@ -170,7 +170,7 @@
"subitems": [
{
"title": "RP2040",
"description": "Our first microcontroller device",
"description": "Raspberry Pi's flagship microcontroller device",
"image": "full-sized/RP2040.png",
"subpath": "rp2040.adoc"
},
Expand All @@ -193,14 +193,14 @@
"subpath": "c_sdk.adoc"
},
{
"title": "PIP",
"description": "The Product Information Portal (PIP) for Raspberry Pi compliance documents",
"title": "Product Information Portal",
"description": "Raspberry Pi compliance documents",
"image": "full-sized/PIP.png",
"url": "https://pip.raspberrypi.com/"
},
{
"title": "Datasheets",
"description": "The Datasheets site for PDF-based documentation",
"description": "PDF-based documentation",
"image": "full-sized/Datasheets.png",
"url": "https://datasheets.raspberrypi.com"
},
Expand Down