Proton models documentation

[witNie]

No description provided.

[Copilot]

Pull request overview

This PR documents the newly-ported proton analytical models in the pyamtrack Python wrapper for the libamtrack Docusaurus documentation site. It adds a dedicated API reference page for the pyamtrack.proton_models module and updates the porting-status table to reflect that these functions are now available. The documented signatures, parameter ranges, defaults, return units, and the Averaging enum all match the actual pyamtrack bindings.

Changes:

• Adds a new proton_models.md API page covering dose_bortfeld and let_wilkens (parameters, validation, cartesian-product evaluation, examples, references).
• Flips the status of the two proton pencil-beam functions from ❌ Not Ported to ✅ Fully Ported in function-status.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
docs/python/API/stopping/proton_models.md	New API reference page for the proton analytical models; content is accurate but the relative cross-doc links (materials.md, ../installation.md, ../function-status.md) are broken.
docs/python/function-status.md	Marks the proton functions as Fully Ported, but uses incorrect function names (proton.bortfeld_dose/proton.wilkens_let instead of proton_models.dose_bortfeld/proton_models.let_wilkens) and omits the doc links used by other ported entries.

Suppressed comments (1)

docs/python/API/stopping/proton_models.md:269

• All three "See also" links are broken relative paths from docs/python/API/stopping/:

• materials.md → resolves to docs/python/API/stopping/materials.md; the file is at docs/python/API/materials.md, so use ../materials.md.
• ../installation.md → resolves to docs/python/API/installation.md; the file is at docs/python/installation.md, so use ../../installation.md.
• ../function-status.md → resolves to docs/python/API/function-status.md; the file is at docs/python/function-status.md, so use ../../function-status.md.

Because docusaurus.config.ts sets onBrokenLinks: 'throw', these broken links will fail the build.

- [Materials](materials.md)
- [Python installation](../installation.md)
- [Function porting status](../function-status.md)

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.