Skip to content

DOC: docs page should have more content #2295

Open
@d-v-b

Description

@d-v-b

Describe the issue linked to the documentation

The landing page for the docs is a small introduction and a series of links:
image

There is actually no content here -- it's just links. But people come to the documentation for content.

Suggested fix for documentation

Instead of asking visitors to figure out which link they must click to get content, we should put some content on the main page (like a simple code example). Look at the pydantic docs landing page:

image

instead of foregrounding the links (which we do on the zarr docs), the links are pushed to the side, and the body of the page is content -- code examples and explanations. We should copy this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions