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

Add more prominent grid editor docs with image. #1731

Merged
merged 1 commit into from
Jun 15, 2024
Merged

Conversation

ntouran
Copy link
Member

@ntouran ntouran commented Jun 15, 2024

The grid editor is a powerful feature, and not easy to discover or featured in the docs. This adds
an intriguing figure (from our fftf isothermal repo) up front so people can see what they're missing
and go looking for the feature.

image

Along the way, I noticed that all png files were
ignored across the repo. Since we use png images
in our documentation, it's important that we do not blanket ignore such files. I struggled for a while to find out why my png wasn't showing up in the options to stage! If we have build artifacts that are ending up in commits then I suggest we clean those out
or be more precise with the ignoring.

Why is the change being made?

This was discussed in #1722


Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

The grid editor is a powerful feature, and not easy
to discover or featured in the docs. This adds
an intriguing figure (from our fftf isothermal repo)
up front so people can see what they're missing
and go looking for the feature.

Along the way, I noticed that all png files were
ignored across the repo. Since we use png images
in our documentation, it's important that we do not
blanket ignore such files. I struggled for a while
to find out why my png wasn't showing up in the options
to stage! If we have build artifacts that are ending
up in commits then I suggest we clean those out
or be more precise with the ignoring.
@john-science john-science added the documentation Improvements or additions to documentation label Jun 15, 2024
@john-science john-science merged commit 3b822bc into main Jun 15, 2024
23 checks passed
@john-science john-science deleted the ntouran/grid-docs branch June 15, 2024 19:27
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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants