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

Adds styling, base content, and new template #65

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

barnesjoseph
Copy link

No description provided.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this was an early draft of the logo. Do you have an updated version?

Copy link
Author

Choose a reason for hiding this comment

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

Our designer confirmed this is the most updated image.

'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think lines 20-22 are unnecessary because we don't have any API docs.

Copy link
Author

Choose a reason for hiding this comment

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

Removed

@@ -0,0 +1,11 @@
Jax AI Stack
=====================================
Copy link
Collaborator

Choose a reason for hiding this comment

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

The length of the underline should match the length of the test (I believe sphinx generates warnings if it doesn't)

Copy link
Author

Choose a reason for hiding this comment

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

Updated

<div class="doc-body">
<section class="hero">
<div>
<h1>Take Full Control of Your Data with JAX AI Stacks</h1>
Copy link
Collaborator

Choose a reason for hiding this comment

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

This looks like an early draft of the content copy – we'll need to update before we can merge this PR.

Copy link
Author

Choose a reason for hiding this comment

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

It is an early version, I'm still waiting on final copy but will update soon.

@jakevdp jakevdp self-assigned this Oct 14, 2024
@trallard
Copy link
Contributor

@barnesjoseph we recently made updates to swap from the Alabaster theme to JupyterBook (as in the JAX docs) - ref: #101

There might now be some conflicts between main and your PR. Would you be able to look into and resolve these?
Feel free to ping if you need an extra set of eyes 👀

@barnesjoseph
Copy link
Author

@barnesjoseph we recently made updates to swap from the Alabaster theme to JupyterBook (as in the JAX docs) - ref: #101

There might now be some conflicts between main and your PR. Would you be able to look into and resolve these? Feel free to ping if you need an extra set of eyes 👀

I've merged main into my branch and resolved conflicts.

@trallard
Copy link
Contributor

trallard commented Nov 25, 2024

Thanks for the super quick update, @barnesjoseph! I just had a quick check, and everything seems okay with the PR build.

Something I noticed is that the tutorials/docs do not have a logo shown. For example, the JAX documentation shows the JAX logo (screenshots included)
Getting_Started_with_JAX_—_JAX_documentation

Tutorials_—_JAX_AI_Stack

So, I wanted to check if this is intentional or if the logo should also be added to the tutorial sidebar.

Also, when hovering over the buttons in light mode, the background colour darkens, which has decent enough contrast with the white text; however, in dark mode and due to the

.button-primary:visited:hover {
    color: white !important;
}

The button background lightens, and the minimal contrast between it and the text makes it hard to read (which hinders accessibility). I thought I would flag this up but not mark it as a must-fix for now (screenshot attached below).

Jax_AI_Stack_—_JAX_AI_Stack

@barnesjoseph
Copy link
Author

Thanks for the super quick update, @barnesjoseph! I just had a quick check, and everything seems okay with the PR build.

Something I noticed is that the tutorials/docs do not have a logo shown. For example, the JAX documentation shows the JAX logo (screenshots included) Getting_Started_with_JAX_—_JAX_documentation

Tutorials_—_JAX_AI_Stack

So, I wanted to check if this is intentional or if the logo should also be added to the tutorial sidebar.

Also, when hovering over the buttons in light mode, the background colour darkens, which has decent enough contrast with the white text; however, in dark mode and due to the

.button-primary:visited:hover {
    color: white !important;
}

The button background lightens, and the minimal contrast between it and the text makes it hard to read (which hinders accessibility). I thought I would flag this up but not mark it as a must-fix for now (screenshot attached below).

Jax_AI_Stack_—_JAX_AI_Stack

I've added some updated CSS to fix the button contrast issue on dark mode. Regarding the docs image comment, this is not in scope for the work my team was tasked with. Our work on this project has concluded as of a couple weeks ago and only pertains directly to the landing page, so any other changes from this point should be directed to Jake.

@trallard
Copy link
Contributor

Thanks for the context. Will bring up the logo item with the rest of the team then.

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.

3 participants