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

docs: add a landing page to the documentation #277

Merged
merged 1 commit into from
Mar 15, 2024

Conversation

12rambau
Copy link
Contributor

@12rambau 12rambau commented Aug 27, 2023

A pydata-sphinx-theme based documentation needs a landing page.

features

  • A centered 2 column landing hero container
  • left is a bit of text + title + 3 buttons (leading nowhere at the moment)
  • right is a demo gif

technical addition

  • hero container required extra css rules
  • demo gif is now existing in both dark and light theme
  • hide the index
  • the hero container is mainly made of pure html to no break other potential builds (👋 .pdf)

image

@mariobuikhuizen
Copy link
Collaborator

The landing page looks much better than the site-map previously! Awesome the demo gif is now dark-mode enabled!

The buttons/links don't seem to work, but I don't know if this PR is ready yet.

@12rambau
Copy link
Contributor Author

12rambau commented Sep 7, 2023

the button are pointing to pages that are not yet existing so I send them to "#", the PR is ready to merge !

@mariobuikhuizen
Copy link
Collaborator

Ok, let's wait for those pages to be available, otherwise we'll have broken links on the doc-site when we need to release from master.

@12rambau 12rambau mentioned this pull request Oct 19, 2023
@12rambau
Copy link
Contributor Author

12rambau commented Nov 7, 2023

require #278 to move forward

@mariobuikhuizen
Copy link
Collaborator

What is we removed the dead links for now, then we can merge the landing page. We'll add back the links in PR's that have the actual content?

@12rambau
Copy link
Contributor Author

@mariobuikhuizen I left the code of the buttons but made them disapear. In this configuration, wiring them once the other pages are ready will be super easy and we don't show to users dead links.

Copy link
Collaborator

@mariobuikhuizen mariobuikhuizen left a comment

Choose a reason for hiding this comment

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

Looks good! Only needs some changes to the text.

docs/index.rst Outdated Show resolved Hide resolved
@mariobuikhuizen mariobuikhuizen merged commit 58eaa5b into widgetti:master Mar 15, 2024
10 of 12 checks passed
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