Skip to content

docs: pre-release verification (resync with latest docs, fix discrepancies)#665

Merged
planetf1 merged 4 commits intogenerative-computing:mainfrom
planetf1:docs/pre-release-verification-645
Mar 17, 2026
Merged

docs: pre-release verification (resync with latest docs, fix discrepancies)#665
planetf1 merged 4 commits intogenerative-computing:mainfrom
planetf1:docs/pre-release-verification-645

Conversation

@planetf1
Copy link
Contributor

@planetf1 planetf1 commented Mar 17, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

  • Link to Issue:

Related #645, #667

(Keeping issue open as there are still many PRs in flight, and will need another iteration to ensure all clear)

Pre-release documentation verification pass:

  • Fix 7 missing Returns: docstring sections (core, plugins, stdlib)
  • Fix Yields: section for json_extraction generator (was incorrectly Returns:)
  • Delete stale docs/index.md and docs/PR601-REVIEW.md
  • Add validate_stale_files() — catches review artifacts and superseded files
  • Add validate_doc_imports() — verifies mellea.* imports in doc code blocks resolve
  • Fix stale imports in glossary.md (ChatContext/SimpleContext paths) and intrinsics.md (GraniteCommonAdapterCustomIntrinsicAdapter)
  • Wire new checks into docs-publish.yml validate step
  • Opened docs: MelleaPlugin and MelleaBasePayload missing from API coverage #667 for MelleaPlugin/MelleaBasePayload coverage gap (Griffe static analysis picks up stubs, not real classes)

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

17/17 validation tests pass (uv run pytest tooling/docs-autogen/test_validate.py -v).

@github-actions
Copy link
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@mergify
Copy link

mergify bot commented Mar 17, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

@planetf1 planetf1 changed the title Docs/pre release verification (resync with latest docs, fix discrepancies) docs: pre-release verification (resync with latest docs, fix discrepancies) Mar 17, 2026
@planetf1 planetf1 force-pushed the docs/pre-release-verification-645 branch from b5c272d to 00e758f Compare March 17, 2026 11:48
@planetf1 planetf1 marked this pull request as ready for review March 17, 2026 11:48
@planetf1 planetf1 requested review from a team, jakelorocco and nrfulton as code owners March 17, 2026 11:48
@planetf1 planetf1 enabled auto-merge March 17, 2026 13:36
- Fix 7 missing Returns sections in core, plugins, stdlib docstrings
- Delete stale docs/index.md and docs/PR601-REVIEW.md artifacts
- Add stale-file detection to validate.py with tests
- Wire stale-file check into docs-publish workflow summary
- Add validate_doc_imports() to check mellea imports in doc code blocks
  resolve at import time (skips optional deps, handles submodule imports)
- Add validate_stale_files() integration with generate_report()
- Fix glossary.md: ChatContext/SimpleContext import paths
- Fix intrinsics.md: GraniteCommonAdapter → CustomIntrinsicAdapter
- Add 3 tests for doc import validation (17/17 pass)
The quality audit incorrectly flagged @contextmanager generators as
missing Returns sections. Generators (Generator, Iterator, etc.) should
use Yields, not Returns. Adds no_yields check kind and
_GENERATOR_RETURN_PATTERNS detection.

Fixes: trace_application/trace_backend no longer flagged for Returns.
New: json_extraction correctly flagged for missing Yields.
@planetf1 planetf1 force-pushed the docs/pre-release-verification-645 branch from 590c8a4 to 0a0b3f0 Compare March 17, 2026 15:04
@planetf1 planetf1 added this pull request to the merge queue Mar 17, 2026
Merged via the queue into generative-computing:main with commit e1f34cd Mar 17, 2026
7 checks passed
@planetf1 planetf1 mentioned this pull request Mar 18, 2026
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.

3 participants