Skip to content

Split User and Developer guides into manageable chunks.#963

Draft
MicahGale wants to merge 11 commits into
jit_parsefrom
doc_rewrite
Draft

Split User and Developer guides into manageable chunks.#963
MicahGale wants to merge 11 commits into
jit_parsefrom
doc_rewrite

Conversation

@MicahGale

@MicahGale MicahGale commented Jun 6, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Checklist for MontePy

Description

Please provide a summary of the change, referencing the issue it fixes, if applicable. Include relevant context and motivation.

Fixes #943


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 or 26.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).

LLM Disclosure

  1. Are you?

    • A human user
    • A large language model (LLM), including ones acting on behalf of a human
  2. Were any large language models (LLM or "AI") used in to generate any of this code?

  • Yes
    • Model(s) used:
  • No

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:

  • This PR fully addresses and resolves the referenced issue(s).
  • 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--963.org.readthedocs.build/en/963/

MicahGale and others added 11 commits June 6, 2026 00:28
- Fix conf.py: remove accidentally embedded terminal output, wire up
  schema_org extension with sys.path, extensions list, and configs
- Add SoftwareApplication JSON-LD to index page and FAQPage JSON-LD
  to faq page; move injection to <head> via extrahead block
- Add meta descriptions to all user-facing RST pages; fix typo and
  trim starting.rst description to under 155 chars
- Add sphinx-sitemap for per-page sitemap coverage; set
  sitemap_url_scheme to suppress version/lang prefix; use
  READTHEDOCS_CANONICAL_URL for html_baseurl
- Update robots.txt: fix inline comment, block /en/v prefix for all
  versioned releases, add stable sitemap URL

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Splits doc/source/starting.rst (1,429 lines) into a thin landing page
plus 7 focused pages under doc/source/guide/. Splits developing.rst
(690 lines) and dev_standards.rst (312 lines) into thin landing pages
plus 10 focused pages under doc/source/devguide/. Incorporates all
jit_parse additions: JIT parsing user guide into guide/reading_writing,
Type and Value Enforcement into devguide/type_enforcement, and JIT
internals into devguide/jit_parsing. Updates devguide/mcnp_object to
use the new hook-methods pattern (_init_blank, _parse_tree,
_generate_default_tree) and devguide/collections_dev to remove the
stale update_pointers reference.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@MicahGale MicahGale changed the base branch from develop to jit_parse June 6, 2026 05:44
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.

Revise Getting Started Guide into multiple pages

1 participant