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 Scribe-Data Logo into Docs Sidebar and Update Color Scheme #92

Merged
merged 3 commits into from
Mar 9, 2024

Conversation

mhmohona
Copy link
Member

@mhmohona mhmohona commented Mar 5, 2024

Contributor checklist

  • This pull request is on a separate branch and not the main branch

Description

Changes made:

  • Added ScribeDataLogo.png (logo) to the _static folder.
  • Updated conf.py to include html_logo and reference the new logo.
  • Introduced custom.css with styles for sidebar header color, text color, and logo padding.

Tested locally to ensure that the layout appears correctly and that the logo is properly integrated within the sidebar.

image

Related issue

Copy link

github-actions bot commented Mar 5, 2024

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. It'd be great to have you!

Maintainer checklist

  • The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution

    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo
  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

'display_version': False,
}

# importing custom css for theme customization
Copy link
Member

Choose a reason for hiding this comment

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

Quick note on this is it'd be great if comments were complete sentences with capitalization and a period at the end in the future, but no stress 😊 If they're inline comments then we can ignore the capitalization and punctuation, but it's Python style that comments that are their own line are fully formatted sentences :)

Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

30969ec did the fixes for the comments as discussed above, @mhmohona 😊 Really great stuff here! Thank you!

@andrewtavis andrewtavis merged commit c09c74c into scribe-org:main Mar 9, 2024
1 check passed
@mhmohona
Copy link
Member Author

mhmohona commented Mar 10, 2024

@andrewtavis, Thank you for your guideline. I will keep it in mind in future.

so after merging this PR, now I am seeing texts in sidebar becomes white when I hover mouse on them -
image

But when I am running locally it looks like this -
image

@andrewtavis
Copy link
Member

andrewtavis commented Mar 10, 2024

Would make sense to do an issue for this, @mhmohona! Thanks for checking!

@mhmohona
Copy link
Member Author

@andrewtavis, instead of issue, I submitted the #100, hopefully which is gonna fix the problem.

@andrewtavis
Copy link
Member

Thank you! I'll take a look as soon as I can :)

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.

Add Scribe-Data logo to the documentation sidebar header
2 participants