documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Published 20 hours ago • verified publisher icon raspberrypi

Need some meta-documentation

Open aallan opened this issue 10 months ago • 7 comments

After the Bookworm launch we probably need a Writing.md to go alongside the README.md that talks about how to use some of the macros we now have for the documentation site. So, things that probably need documenting:

  • How to reference a white paper, see #2973
  • How to reference a Raspberry Pi Press book, see #3035
  • How to reference a tutorial, see #3060

Probably also need to document how to xref: sections between different pages, and how to reference sections inside the same page. Because of the way we use section titles as default anchors, and other issues it's not as obvious as it could be.

Can't think of anything else that needs documenting though, anyone?

aallan avatar Sep 05 '23 09:09 aallan