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

Added tutorials for new material API. #612

Open
wants to merge 18 commits into
base: alpha-test-dev
Choose a base branch
from
Open

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Dec 10, 2024

Pull Request Checklist for MontePy

Description

This is the main alpha deploy documentation update. Update tutorial and migration plan. Also adding some dev documentation.

Fixes #606, fixes #605


General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).
  • I have made corresponding changes to the documentation, providing clear details on the added or modified functionality (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 tests pass locally before CI checks.
  • The PR covers all relevant aspects according to the development guidelines.
    """

@MicahGale MicahGale added documentation Improvements or additions to documentation alpha testing Issues that came up during alpha testing labels Dec 10, 2024
@MicahGale MicahGale marked this pull request as ready for review December 10, 2024 16:50
@MicahGale MicahGale requested a review from tjlaboss December 10, 2024 16:51
@MicahGale MicahGale self-assigned this Dec 10, 2024
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.

I want to mess around with the alpha test branch with fresh eyes to see if the new documentation makes sense, but here are some initial things to address.

I'll push a commit to this branch with some punctuation changes too

doc/source/migrations/migrate0_1.rst Outdated Show resolved Hide resolved
doc/source/migrations/migrate0_1.rst Outdated Show resolved Hide resolved
doc/source/migrations/migrate0_1.rst Outdated Show resolved Hide resolved
doc/source/migrations/migrate0_1.rst Outdated Show resolved Hide resolved
doc/source/starting.rst Outdated Show resolved Hide resolved
doc/source/starting.rst Show resolved Hide resolved
doc/source/starting.rst Show resolved Hide resolved
doc/source/starting.rst Outdated Show resolved Hide resolved
doc/source/starting.rst Outdated Show resolved Hide resolved
doc/source/migrations/migrate0_1.rst Show resolved Hide resolved
@MicahGale
Copy link
Collaborator Author

Nucleardata.lanl.gov seems to be having issues beyond our control: https://mcnp.discourse.group/t/nuclear-data-site-errors/2299

@MicahGale MicahGale requested a review from tjlaboss December 15, 2024 21:17
@tjlaboss
Copy link
Collaborator

tjlaboss commented Jan 6, 2025

I'll push a commit to this branch with some punctuation changes too

still need to do this

@MicahGale
Copy link
Collaborator Author

I'll push a commit to this branch with some punctuation changes too

still need to do this

I did try to address all of the grammar changes you suggested, but I suspect you got tired of noting all of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alpha testing Issues that came up during alpha testing documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants