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.

Sign up for GitHub

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

Jump to bottom

Update docs #1227

Merged
merged 5 commits into from
Sep 27, 2024
Merged

Update docs #1227

merged 5 commits into from
Sep 27, 2024

Conversation

WeilerP
Copy link
Member

@WeilerP WeilerP commented Sep 26, 2024

IMPORTANT: Please search among the Pull requests before creating one.

Description

  • Update overview figures
  • Drop email support
  • Update citations

Closes

Closes #1226.

@WeilerP
Update overview
e5c8d68
@WeilerP
Update docs/index.rst
9e804c4 
- Add banner for proper citation
- Drop email support
- Add CR2 manuscript in "Getting Started with CellRank" section
- Update spelling
@WeilerP
Update README.rst
8718d0a 
- Add banner for citation
- Remove email support
- Update CR2 DOI to publication
michalk8
michalk8 requested changes Sep 26, 2024
View reviewed changes
Copy link
Collaborator

@michalk8 michalk8 left a comment

Choose a reason for hiding this comment

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

Thanks a lot @WeilerP , just some minor comments!

docs/_static/img/dark_mode_overview.png Show resolved Hide resolved
docs/_static/img/light_mode_overview.png Show resolved Hide resolved
@michalk8 michalk8 added the documentation Improvements or additions to documentation label Sep 26, 2024
@WeilerP
Update overview figures
9178743 
- Reduce overall size
- Reduce file size
@Marius1311
Copy link
Collaborator

Thanks @WeilerP! I think on the landing page, we should have a direct link to our published papers, not just a citation. Otherwise, users have to first click the citation, then they get forwarded to the hughe list of references, and then they need to click again.

The links to our papers should be prominently places, and I think users should get to the published articles with a single click.

@Marius1311
Copy link
Collaborator

What about tutorials - should we also update them, or start with just the docs for now? They also contain outdated figures.

@michalk8 michalk8 self-requested a review September 26, 2024 12:45
michalk8
michalk8 approved these changes Sep 26, 2024
View reviewed changes
Copy link
Collaborator

@michalk8 michalk8 left a comment

Choose a reason for hiding this comment

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

From my side LGTM!, but as Marius says, we should also update the tutorials.
As for the direct citation on the landing page, no strong opinion there, think it's ok as it is now (it's prominent enough).

@WeilerP
Update index.rst
2465fd3 
Add direct links to publications.
WeilerP
WeilerP commented Sep 26, 2024
View reviewed changes
docs/index.rst Show resolved Hide resolved
Marius1311
Marius1311 approved these changes Sep 27, 2024
View reviewed changes
Copy link
Collaborator

@Marius1311 Marius1311 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. Do you want to mention that we won the Helmholtz Software Award? It think it's a great achievement.

README.rst Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
@WeilerP
Copy link
Member Author

WeilerP commented Sep 27, 2024

Looks great. Do you want to mention that we won the Helmholtz Software Award? It think it's a great achievement.

Let's wait until we officially received it, okay?

@WeilerP WeilerP merged commit 7fa8658 into theislab:main Sep 27, 2024
3 of 9 checks passed
@WeilerP WeilerP deleted the feat/update_docs branch September 27, 2024 11:56
@Marius1311
Copy link
Collaborator

Up to you, but we officially won it, just the ceremony is outstanding: https://www.hifis.net/news/2024/07/18/sw-award-final.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michalk8 michalk8 michalk8 approved these changes

@Marius1311 Marius1311 Marius1311 approved these changes

Assignees

@WeilerP WeilerP

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs outdated
3 participants
@WeilerP @Marius1311 @michalk8