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

Add 1xp docs announcement section to documentation home page #10594

Closed
mackinziblank opened this issue Aug 8, 2023 · 5 comments · Fixed by #10640
Closed

Add 1xp docs announcement section to documentation home page #10594

mackinziblank opened this issue Aug 8, 2023 · 5 comments · Fixed by #10640
Assignees

Comments

@mackinziblank
Copy link

To announce the new documentation experience being released, we should add this announcement section on the documentation home page.

image

fyi @javabster

@javabster javabster transferred this issue from Qiskit/qiskit_sphinx_theme Aug 8, 2023
@javabster
Copy link
Contributor

Because this homepage is generated with Sphinx we are somewhat limited in how we can style components that sit within the body of the page. We have 2 options, a Qiskit Card directive or a Qiskit CTA directive:

Qiskit Card Directive - provides the full width box with an image, the entire box is clickable:

Screenshot 2023-08-08 at 5 46 50 PM

Qiskit CTA directive - doesn't have a full width box but has text and a grey button that could include CTA text

Screenshot 2023-08-08 at 5 48 04 PM

@mackinziblank which do you think would be better?

@JulesMurphy
Copy link

@javabster I prefer the first option personally, as it is more visually prominent. Is there any way to include link text within the content in option 1?

@javabster
Copy link
Contributor

in option 1 the whole box is a clickable link. I could add whatever text you want within the box, but i don't think i could put a link inside because the whole box is technically a link

@JulesMurphy
Copy link

We probably just need to include an arrow icon or something at the end of the text to make it feel more clickable. Does it have a hover state?

@javabster
Copy link
Contributor

Yep!

Screen.Recording.2023-08-09.at.11.02.43.AM.mov

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
4 participants