Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: docs page should have more content #2295

Open
d-v-b opened this issue Oct 2, 2024 · 0 comments
Open

DOC: docs page should have more content #2295

d-v-b opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic

Comments

@d-v-b
Copy link
Contributor

d-v-b commented Oct 2, 2024

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.

@d-v-b d-v-b added help wanted Issue could use help from someone with familiarity on the topic documentation Improvements to the documentation labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic
Projects
None yet
Development

No branches or pull requests

1 participant