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

"getting started icon" #2569

Open
d-v-b opened this issue Dec 18, 2024 · 4 comments
Open

"getting started icon" #2569

d-v-b opened this issue Dec 18, 2024 · 4 comments

Comments

@d-v-b
Copy link
Contributor

d-v-b commented Dec 18, 2024

I'm not a fan of the icon over the "getting started" section of the docs landing page, it conveys "running away from danger" to me much more than "getting started with something":

Image

IMO the text "getting started" alone is sufficient, and so we could just remove that icon entirely. Any thoughts?

@jhamman
Copy link
Member

jhamman commented Dec 19, 2024

I don't think this is a big deal. You'll find that same icon in a number of places around the ecosystem:

Certainly open to replacing the icon but doesn't seem like much of a priority to me.

@d-v-b
Copy link
Contributor Author

d-v-b commented Dec 19, 2024

I find that icon is weird in all those other places too. But I do think my bigger objection is to the layout itself -- "getting started" is actually the job of the main page and so I don't think it needs its own category. Also, I don't think the other categories should be displayed in a grid, each with their own large icons, etc. I agree that it's not a big priority right now, but I would very much support restructuring our docs to be organized more like pydantic's

@jhamman
Copy link
Member

jhamman commented Dec 19, 2024

Just a quick note to mention that all of these sites are attempting to follow the Diátaxis framework: https://diataxis.fr/

Not saying we're doing it super well but that is the origin for this layout.

@d-v-b
Copy link
Contributor Author

d-v-b commented Dec 19, 2024

i think the diataxis idea is great insofar as it suggest 4 categories of content to have on our docs, but centerpiecing those 4 categories as links on the main page seems like a wonky implementation -- not even the diataxis site itself does this (it only displays the categories as an image)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants