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

New header and footer #18

Merged
merged 4 commits into from
Nov 6, 2024
Merged

New header and footer #18

merged 4 commits into from
Nov 6, 2024

Conversation

tillywoodfield
Copy link
Contributor

@tillywoodfield tillywoodfield commented Oct 22, 2024

No description provided.

@tillywoodfield tillywoodfield force-pushed the design-system-upgrade branch 4 times, most recently from 42e928b to 4720c8f Compare October 23, 2024 08:11
@tillywoodfield
Copy link
Contributor Author

@robredpath, here is an initial version of the new header/footer on the Sphinx theme to look at and let me know which sections/links should be included etc.

@robredpath
Copy link
Contributor

I've deployed this to https://iati-sphinx-theme.readthedocs-hosted.com/en/design-system-upgrade/ for testing and demo

@robredpath
Copy link
Contributor

Exciting!

Header

  • Remove the Help Docs link because these are the help docs
  • Keep the English (even if there's only English) because it tells the user that it's only available in English.
  • Make "Tool Home" take on the name of the tool (ideally from conf).

Footer
I think we can condense that down to two horizontal sections: a top one (called "additional information") with the Sphinx version, a link to the GH repo where the docs come from and the license (CC-BY-4.0 with link); a bottom one as-is without the Sphinx version

@robredpath
Copy link
Contributor

Oh - and one other question. What do we want to do about the floating RTD switcher widget? We probably want it for version switching during development but I don't think we want to include it in our users' interactions.

Can we do something smart like make it appear if we have a certain cookie set or something like that?

@tillywoodfield tillywoodfield force-pushed the design-system-upgrade branch 8 times, most recently from f9bace3 to 3ac62f8 Compare November 5, 2024 14:13
@tillywoodfield
Copy link
Contributor Author

@robredpath I've updated the header and footer as per your comments, and as discussed we will leave the RTD flyout menu as-is for now and look into how we can choose display or hide it at build time as a follow up task

Copy link
Contributor

@robredpath robredpath left a comment

Choose a reason for hiding this comment

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

🎉

@tillywoodfield tillywoodfield merged commit 3ee34ae into main Nov 6, 2024
3 checks passed
@tillywoodfield tillywoodfield deleted the design-system-upgrade branch November 6, 2024 11:52
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.

2 participants