Skip to content

Added some top level use case info to help with keywords for SEO. #775

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

Merged
merged 3 commits into from
Jul 7, 2025

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Jul 4, 2025

Pull Request Checklist for MontePy

Description

This adds some keywords that I learned a user was searching for and barely was able to find MontePy with this search. This tries to add some keywords by using some "use cases" to top level documentation. This will hopefully add useful keywords that SEO will like, without engaging in keyword packing that is penalized, by being natural and actually helpful. Yes this violates my views on the words "card" and "decks". However, I have learned: this is what some users search, and if we want to be helpful, we need to meet the users halfway.

Fixes #754


General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have formatted my code with black version 25.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).

Documentation Checklist

  • I have documented all added classes and methods.
  • For infrastructure updates, I have updated the developer's guide.
  • For significant new features, I have added a section to the getting started guide.

First-Time Contributor Checklist

  • If this is your first contribution, add yourself to pyproject.toml if you wish to do so.

Additional Notes for Reviewers

Ensure that:

  • The submitted code is consistent with the merge checklist outlined here.
  • The PR covers all relevant aspects according to the development guidelines.
  • 100% coverage of the patch is achieved, or justification for a variance is given.

📚 Documentation preview 📚: https://montepy--775.org.readthedocs.build/en/775/

@MicahGale MicahGale requested a review from tjlaboss July 4, 2025 16:07
@MicahGale MicahGale self-assigned this Jul 4, 2025
@MicahGale MicahGale added the documentation Improvements or additions to documentation label Jul 4, 2025
@MicahGale MicahGale linked an issue Jul 4, 2025 that may be closed by this pull request
Copy link
Collaborator

@tjlaboss tjlaboss left a comment

Choose a reason for hiding this comment

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

LGTM

image

We should also consider (not necessarily as part of this PR) how to improve visibility on Pypi. We're only No. 17 by Relevance, behind some search results which are far less relevant or mature.

@MicahGale
Copy link
Collaborator Author

Agreed. Though how PyPI search works is such a black box it's hard to optimize for.

@MicahGale MicahGale merged commit 4d7e3b3 into develop Jul 7, 2025
24 checks passed
@MicahGale MicahGale deleted the 754-add-parameterized-for-seo branch July 7, 2025 19:32
@MicahGale MicahGale mentioned this pull request Jul 7, 2025
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.

Add parameterized for SEO
2 participants