Skip to content

[WIP] Update text, documentation and images for the release#1172

Open
MBartkowiakSTFC wants to merge 17 commits intoprotosfrom
release-update
Open

[WIP] Update text, documentation and images for the release#1172
MBartkowiakSTFC wants to merge 17 commits intoprotosfrom
release-update

Conversation

@MBartkowiakSTFC
Copy link
Copy Markdown
Collaborator

Description of work
Some cosmetic changes are necessary before the release.

The version numbers will be handled by PR #1149

Fixes

  1. Updated the splash screen image.
  2. Changed the text of README files, removing the mentions of this being a pre-release.
  3. Cleaned up documentation of q vector generators, removing the obsolete entries.
  4. Fixed a typo in one of the stylesheets.

To test
Comments welcome.

Copy link
Copy Markdown
Collaborator

@oerc0122 oerc0122 left a comment

Choose a reason for hiding this comment

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

All looks good, but we might want to wait until we're absolutely final on 2.0.0 before merging this?

header="MDANSE Trajectory",
footer="Look up our "
+ '<a href="https://mdanse.readthedocs.io/en/protos/">Read The Docs</a>'
+ '<a href="https://mdanse.readthedocs.io/">Read The Docs</a>'
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Seeing all this does make me think we want a constant somewhere containing this string. DEFAULT_FOOTER?

@MBartkowiakSTFC
Copy link
Copy Markdown
Collaborator Author

All looks good, but we might want to wait until we're absolutely final on 2.0.0 before merging this?

Agreed.

README.md Outdated
Comment on lines 236 to 237
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Link doesn't work

Image

it goes to

Image

when you click it.

README.md Outdated
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think we removed all the code copied from MDTraj right?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I think it was all in the Cython extensions, and so it should be gone, yes.

identified and corrected. Please help us develop MDANSE by reporting any
problems you experience when using the code. The preferred way of reporting
problems is by adding them to the
This is the first release of MDANSE 2.0.0.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Does this want to be in an admonition?

> [!INFORMATION]
> Example

Note: Not 100% sure it'll work.

contains will not change by the time the full release has been made. However,
there still may be some problems with the code at this stage that need to be
identified and corrected.
This is the first release of MDANSE_GUI 2.0.0.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question as other if it works.

you experience while using MDANSE. The preferred way of reporting
problems is by adding them to the

Considering the large number of different MD engines and analysis types,
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

And again

Co-authored-by: Jacob Wilkins <46597752+oerc0122@users.noreply.github.com>
Signed-off-by: Maciej Bartkowiak <108934199+MBartkowiakSTFC@users.noreply.github.com>
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.

3 participants