Skip to content

DOC: Fix source links in memory data types page - #3695

Merged
Roman Lutz (romanlutz) merged 6 commits into
microsoft:mainfrom
pratikgx:doc-memory-data-types-links
Nov 1, 2026
Merged

Roman Lutz (romanlutz) merged 6 commits into
microsoft:mainfrom
pratikgx:doc-memory-data-types-links

Conversation

@pratikgx

@pratikgx Pratik Gandhi (pratikgx) commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Description

Fix five source links in doc/code/memory/3_memory_data_types.md that point to files moved into subpackages:

  • pyrit/models/message_piece.py -> pyrit/models/messages/message_piece.py
  • pyrit/models/message.py -> pyrit/models/messages/message.py
  • pyrit/models/score.py -> pyrit/models/score/score.py
  • pyrit/identifiers/component_identifier.py -> pyrit/models/identifiers/component_identifier.py
  • pyrit/identifiers/evaluation_identifier.py -> pyrit/models/identifiers/evaluation_identifier.py

Also prevent this from going unnoticed again: the docs workflow checks the latest slot, including PR validation, with --site --strict --check-links before rendering. Frozen release builds keep their existing behavior. Local make docs-build enables link checking too.

Enabling the full check also exposed another stale Score source link, two unresolved Docker provenance references, and an automatically generated HTTP link for crates.io. Correct those and update the contributor build instructions. Keep exact-URL exceptions for the existing Commons image attribution and the crates.io homepage, which reject automated requests. Other URLs on those sites are not excluded.

No runtime API changes.

Tests and Documentation

Validated after merging current main, using Python 3.13 and locked Jupyter Book 2.1.7:

  • uv run --frozen --no-sync pytest -q tests\unit\build_scripts\test_docs_workflow.py tests\unit\build_scripts\test_docs_build_contract.py tests\unit\build_scripts\test_resolve_docs_matrix.py: 71 passed.
  • uv run --frozen --no-sync python -m build_scripts.pydoc2json pyrit --submodules -o doc\_api\pyrit_all.json: passed.
  • uv run --frozen --no-sync python -m build_scripts.gen_api_md: passed, including documentation-structure validation.
  • From doc, uv run --frozen --no-sync jupyter-book build --html --strict --check-links: passed, producing the full static HTML book. Existing non-fatal warnings remain.
  • uv run --frozen --no-sync ruff check tests\unit\build_scripts\test_docs_workflow.py tests\unit\build_scripts\test_docs_build_contract.py doc\code\scoring\0_scoring.py doc\scanner\garak.py: passed.
  • uv run --frozen --no-sync ruff format --check tests\unit\build_scripts\test_docs_workflow.py tests\unit\build_scripts\test_docs_build_contract.py doc\code\scoring\0_scoring.py doc\scanner\garak.py: passed.
  • Commit-time pre-commit hooks: passed.

Reproduction: with the original five broken links, --site --strict succeeds, but adding --check-links fails with exactly five link errors. The corrected page passes with --check-links.

Updated each affected notebook and its paired percent-format Python file inline. Verified source synchronization and preserved all notebook outputs, metadata, and execution counts. Notebooks were not executed against AI providers; PDF export was not run.

@romanlutz Roman Lutz (romanlutz) self-assigned this Nov 1, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Roman Lutz (romanlutz) added a commit to FazeelUsmani/PyRIT that referenced this pull request Nov 1, 2026
Integrate microsoft#3770, microsoft#3697 and microsoft#3695 normally. As requested, retain the upstream deterministic one-node mapping-budget assertion, truncation and exact totals; do not restore the removed wall-clock benchmark.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@romanlutz
Roman Lutz (romanlutz) added this pull request to the merge queue Nov 1, 2026
Merged via the queue into microsoft:main with commit 5000620 Nov 1, 2026
86 of 105 checks passed
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.

2 participants