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

docs: add logo, dark mode, boost search #1936

Merged
merged 2 commits into from
Dec 4, 2023

Conversation

ion-elgreco
Copy link
Collaborator

@ion-elgreco ion-elgreco commented Dec 3, 2023

  • Adds transparent logo (we need a higher quality one), I've pinged @fvaleye on Slack to check whether he has one.
  • Add dark mode toggle
  • Boost some search results since it was prioritizing the guides over the API reference

@roeap
Copy link
Collaborator

roeap commented Dec 3, 2023

if the logo is transparent, should we use it in the README as well?

w.r.t. boosting API reference, depending on the audience, the examples might be more helpful? maybe @MrPowers has an opinion?

@MrPowers
Copy link
Collaborator

MrPowers commented Dec 3, 2023

LGTM, but not sure about the search boosting... My guess is that we want the usage/integration pages ranked above the API docs (and the usage pages linking to the API docs). Open to thoughts. Normally I don't think API docs give the best SEO experience.

@ion-elgreco
Copy link
Collaborator Author

ion-elgreco commented Dec 4, 2023

@roeap let's wait on a higher quality version of the transparent logo from Florian. This one I made myself with paint 3d but the edges are quite rough and the resolution got lower because of that.

@MrPowers I personally prefer the API reference to hit first in the search box. For example, I was looking for write_deltalake. The first 10 hits were all the guides, only the last one was the actual API reference.

So now with the boosting, the API reference will be first and then all the guides.

@roeap
Copy link
Collaborator

roeap commented Dec 4, 2023

@dennyglee made me aware of the assets available in the delta-docs repo. Maybe we should use these? There are high quality PNGs as well as SVG versions available.

@ion-elgreco
Copy link
Collaborator Author

Awesome @roeap @dennyglee! That was what I was looking for :D

Copy link
Collaborator

@roeap roeap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great!

Re the boosting stuff, since API reference returns much fewer results, I guess the guides will still be visible on the result set - in contrast to the other way around.

@ion-elgreco ion-elgreco merged commit d441940 into delta-io:main Dec 4, 2023
24 checks passed
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

Successfully merging this pull request may close these issues.

None yet

3 participants