Code

Overhaul documentation#674

Code

Merged

callumforrester merged 21 commits intomainDiamondLightSource/blueapi:mainfrom docs-overhaulDiamondLightSource/blueapi:docs-overhaulCopy head branch name to clipboardNov 28, 2024

+514-483

Commits

Commits on Nov 25, 2024

• Complete basic set of tutorials

  callumforrester

  committed
  e071afe

• Split out writing plans and devices section

  Show description for 664e0f4
  callumforrester

  committed
  664e0f4

• Add info about writing devices

  callumforrester

  committed
  ded57f2

• Make tutorial actually work

  callumforrester

  committed
  b1cf10a

• Tidy up how tos

  callumforrester

  committed
  5f6ce25

• Tidy up explanations

  callumforrester

  committed
  96bde32

• Fix references

  callumforrester

  committed
  3198f50

• Consistent title capitalisation

  callumforrester

  committed
  581e3ca

• Remove lie

  callumforrester

  committed
  356c119

• Remove broken image from readme

  callumforrester

  committed
  6b46a4e

• Fix indent

  callumforrester

  committed
  07b8285

• Action suggestions for home of plans and devices page

  callumforrester

  committed
  bd6d880

• Remove references to inject

  callumforrester

  committed
  0a63937

• Apply generalisation of external connections in docs

  Show description for 94a95b8
  

  callumforrester

  and

  DiamondJoseph

  committed
  94a95b8

• Fix markdown check

  callumforrester

  committed
  dd5d750

• Correct MsgGenerator import

  Show description for e9916b9
  

  callumforrester

  and

  DiamondJoseph

  authored
  e9916b9

• Fix typo

  Show description for 9e3e3b5
  

  callumforrester

  and

  DiamondJoseph

  authored
  9e3e3b5

• Should vs must

  Show description for 529ea2d
  

  callumforrester

  and

  DiamondJoseph

  authored
  529ea2d

• Correct attach metadata decorator.

  Show description for 1e05386
  

  callumforrester

  and

  DiamondJoseph

  authored
  1e05386

Commits on Nov 28, 2024

• Make metadata examples mutable

  callumforrester

  committed
  d66e431

• Remove some duplication between type validators and plan lifecycle explanations

  callumforrester

  committed
  674f5e1