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

Updated website with images and branding #96

Merged
merged 10 commits into from
Dec 19, 2023
Merged

Conversation

niksirbi
Copy link
Member

@niksirbi niksirbi commented Dec 19, 2023

Closes #40
Closes #81
Closes #73

This PR revamps the website to make it more presentable:

Among other small things, it applies NIU branding #40, adds a chat icon with the Zulip link to the top right #73, and adds the sphinx-sitemap extension #81.

The Zulip link now points to the entire "movement" stream, not a particular topic (the "Welcome" post had outdated links and will be deleted).

It also adds some images to the README, homepage, and getting started guide.

The website deployment workflow can now be also triggered via a manual workflow dispatch, to allow the docs to be deployed independently of software release, if necessary (implementation copied from RatInABox).

The best way to review this PR is to build the docs locally and check the result in both light and dark modes.

Copy link

codecov bot commented Dec 19, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a3671df) 98.57% compared to head (34df592) 98.57%.

❗ Current head 34df592 differs from pull request most recent head 864d6d2. Consider uploading reports for the commit 864d6d2 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #96   +/-   ##
=======================================
  Coverage   98.57%   98.57%           
=======================================
  Files           8        8           
  Lines         420      420           
=======================================
  Hits          414      414           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@niksirbi niksirbi added the documentation Improvements or additions to documentation label Dec 19, 2023
@niksirbi niksirbi marked this pull request as ready for review December 19, 2023 15:43
@niksirbi niksirbi requested a review from adamltyson December 19, 2023 15:43
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

Looks great, I left a couple of tiny comments.

docs/source/_static/light-logo-niu_with-text.png Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@niksirbi niksirbi merged commit 8de04fe into main Dec 19, 2023
17 checks passed
@niksirbi niksirbi deleted the update-readme-and-homepage branch December 19, 2023 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants