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

🎨 Update docs theme and add tutorial #1184

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented May 27, 2024

  • Update the theme to furo and colors to match new branding
  • Restructure toc-trees, to make the documentation easier to navigate
  • Improve landing page
    • Improve top "hero" section
    • Add feature section
    • move examples to tutorial
  • Add tutorial page, with worked example covering most directives

https://sphinx-needs--1184.org.readthedocs.build/en/1184/


Note, one last thing that I would like to do,
is to add a clear indication that this is "powered by useblocks",
with a link to the main useblocks site (and enteprise tools) on the landing page and "next steps" of tutorial.
But this is waiting on the new site being released.

@chrisjsewell chrisjsewell changed the title 👌 Multi-theme support 🎨 Update docs theme May 27, 2024
Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.44%. Comparing base (1de1a7a) to head (b2389e0).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1184   +/-   ##
=======================================
  Coverage   86.44%   86.44%           
=======================================
  Files          56       56           
  Lines        6501     6501           
=======================================
  Hits         5620     5620           
  Misses        881      881           
Flag Coverage Δ
pytests 86.44% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@chrisjsewell chrisjsewell force-pushed the new-doc-theming branch 5 times, most recently from 716fbf7 to fe6ed55 Compare June 3, 2024 07:35
@chrisjsewell chrisjsewell changed the title 🎨 Update docs theme 🎨 Update docs theme and add tutorial Jun 3, 2024
@chrisjsewell chrisjsewell force-pushed the new-doc-theming branch 2 times, most recently from 06444a9 to 74e25e1 Compare June 3, 2024 07:48
@chrisjsewell chrisjsewell force-pushed the new-doc-theming branch 2 times, most recently from 1f82ced to 24e8971 Compare June 13, 2024 11:58
@chrisjsewell chrisjsewell marked this pull request as ready for review June 28, 2024 17:38
@chrisjsewell chrisjsewell requested a review from danwos June 28, 2024 18:35
docs/tutorial.rst Outdated Show resolved Hide resolved
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.

None yet

1 participant