-
Notifications
You must be signed in to change notification settings - Fork 17
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
base: main
Are you sure you want to change the base?
Conversation
docs/source/_static/images/hero.svg
Outdated
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
docs/source/conf.py
Outdated
'sphinx.ext.duration', | ||
'sphinx.ext.doctest', | ||
'sphinx.ext.autodoc', | ||
'sphinx.ext.autosummary', |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
docs/source/index.rst
Outdated
@@ -0,0 +1,11 @@ | |||
Jax AI Stack | |||
===================================== |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
docs/source/index.html
Outdated
<div class="doc-body"> | ||
<section class="hero"> | ||
<div> | ||
<h1>Take Full Control of Your Data with JAX AI Stacks</h1> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@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 |
I've merged main into my branch and resolved conflicts. |
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) 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
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). |
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. |
Thanks for the context. Will bring up the logo item with the rest of the team then. |
No description provided.