Skip to content

Docs are messy #306

@talmo

Description

@talmo

Right now the docs are in not the best state.

  1. The menu order is all over the place:
Image

It should at a minimum follow the workflow order, but ideally should adopt the Diataxis conventions.

  1. The home page for the docs isn't working: https://nn.sleap.ai/

This 404s, but https://nn.sleap.ai/latest/ works. It should redirect there from the base URL.

  1. The instructions need to have more uv based installation and usage, in particular the uv tool install-based workflow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions