Skip to content

Restructure documentation to make user and developer how-to's clearer. #1468

@abbiemery

Description

@abbiemery

The documentation for Blueapi is currently confusing. The page Run Auth Locally should not be in the tutorial section. This section is for users of the application. Thie page should be in the how-to's in a developer specific section. This page tells you how to run auth up with the example system test services, which is only really useful to develop against.

https://diamondlightsource.github.io/blueapi/main/tutorials/local-auth.html

Acceptance Criteria

  • This page is moved out of the tutorial section
  • There is some grouping or ordering of how-to's to make it clear what is useful for developing blueapi, vs using it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions