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

home page should look friendlier #289

Merged
merged 20 commits into from
Apr 29, 2024
Merged

home page should look friendlier #289

merged 20 commits into from
Apr 29, 2024

Conversation

@prjemian prjemian added the documentation Improvements or additions to documentation label Apr 3, 2024
@prjemian prjemian added this to the v1.0.3 milestone Apr 3, 2024
@prjemian prjemian requested a review from rodolakis April 3, 2024 22:23
@prjemian prjemian self-assigned this Apr 3, 2024
@prjemian prjemian requested a review from MDecarabas April 3, 2024 22:23
@prjemian
Copy link
Contributor Author

prjemian commented Apr 3, 2024

image

@prjemian prjemian marked this pull request as draft April 3, 2024 22:37
@prjemian
Copy link
Contributor Author

prjemian commented Apr 3, 2024

Might get a lot easier if we add the sphinx-design package.

@prjemian
Copy link
Contributor Author

prjemian commented Apr 3, 2024

(That's what bluesky-adaptive is using)

@prjemian
Copy link
Contributor Author

prjemian commented Apr 3, 2024

Half the lines of code, no need for raw html, easier to manage.
image

@prjemian prjemian marked this pull request as ready for review April 3, 2024 23:12
@prjemian
Copy link
Contributor Author

prjemian commented Apr 3, 2024

Download a preview copy of the web site for review from docs actions page. The download is at/near the bottom of the page.

@coveralls
Copy link

coveralls commented Apr 4, 2024

Pull Request Test Coverage Report for Build 8882659580

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.675%

Totals Coverage Status
Change from base Build 8543931001: 0.0%
Covered Lines: 983
Relevant Lines: 1189

💛 - Coveralls

@rodolakis
Copy link
Collaborator

I actually find this a lot better - much less overwhelming. I can tell exactly where I want to go. I don't really see any value in the preview of "some" of the content. I'd rather just pick a category, and then browse from there.

image

@prjemian
Copy link
Contributor Author

prjemian commented Apr 4, 2024

image

@prjemian
Copy link
Contributor Author

View of checklist now (text is pulled from the section title by Sphinx):

image

@prjemian
Copy link
Contributor Author

One more step, at least, to modularize the content after the installation checklist. See TODO items, such as

.. TODO: Could move each section to its own file.

@prjemian
Copy link
Contributor Author

Copy link
Collaborator

@MDecarabas MDecarabas left a comment

Choose a reason for hiding this comment

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

Home page looks great! The one change I would make to the new instrument setup is putting (optional) next to the steps that are not mandatory. Ie: creating an alias

@prjemian
Copy link
Contributor Author

Copy link
Collaborator

@MDecarabas MDecarabas left a comment

Choose a reason for hiding this comment

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

Great!

@prjemian
Copy link
Contributor Author

Thanks MDecarabas!

@prjemian prjemian merged commit 7f2b059 into main Apr 29, 2024
8 checks passed
@prjemian prjemian deleted the 288-safe-home branch April 29, 2024 18:20
@rodolakis
Copy link
Collaborator

Looks great!

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
No open projects
4 participants