Repository navigation
docs: refresh stale documentation - #738
Merged
Merged
Conversation
Fixes the 2026-10 documentation freshness audit. - deployment.md: `generate --app-path ./function_app.py` is not a real flag; replace with `--app function_app:app` (verified against cli.py and by running both snippets against examples/report_jobs). - llms.txt / llms-full.txt: drop the hard-coded 0.27.0 and point at PyPI so the files stop drifting every release. - docs/assets/screenshots.yml: label all nine captures as historical (0.21.2, 2026-08-15) rather than faking a recapture. - SUPPORT.md: "3.11 and above" -> 3.11-3.14, matching requires-python. - development.md / contributing.md / testing.md: remove Black (ruff does formatting), stop duplicating tool version pins, correct the Makefile target tables, state the real 95% coverage gate, and fix the merge-approval claim (branch protection requires 0 approvals; CI checks are the gate). - usage.md: dedent the "Non-standard HTTP methods (OpenAPI 3.2)" heading so it renders as a heading instead of an indented code block. - Ecosystem links: point at the canonical `*-python` repositories in architecture.md, deployment.md, and DESIGN.md. - CONTRIBUTING.md: the CISA alert URL 404s; link the GitHub advisory for CVE-2025-30066 instead. - installation.md: explain that `4-python3.12` is an example tag and list the supported `4-python3.11` .. `4-python3.14` images.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #737
Per-item summary of the acceptance checklist:
generate --app-path— confirmed againstsrc/azure_functions_openapi/cli.py: there is no--app-path. Replaced both snippets with--app function_app:app. Executed both (JSON and YAML) againstexamples/report_jobs; the JSON run emits all three/api/reports*paths.status: historicalon each entry.scripts/check_screenshots.py --strictstill passes.3.11-3.14(>=3.11,<3.15), matchingrequires-python..pre-commit-config.yamlandpyproject.toml(the two pins disagreed with each other and with the docs); corrected both Makefile tables against the real targets; documented the enforced 95% gate (fail_under = 95) in place of the stale 85% target, includingdocs/testing.md; and corrected the review claim — branch protection hasrequired_approving_review_count: 0, so the CI checks are the merge gate, not an approval.###instead of a code block.azure-functions-{langgraph,validation,logging,doctor,scaffold}(no-python) only redirect rather than resolve directly; repointed to the canonical*-pythonrepos indocs/architecture.md,docs/deployment.md, andDESIGN.md. The README tables were already correct.azure-functions-durable-graph-pythonandazure-functions-knowledge-pythonare marked retired upstream and are correctly absent.GHSA-mrrh-fwg8-r2c3, 200).4-python3.12is an example and listed the supported tags; verified4-python3.11through4-python3.14all exist in the MCR tag list.docs/architecture.mdwas touched for ecosystem links only, leaving the decorator-order content for #736.Verification
mkdocs build --strict— cleanscripts/check_screenshots.py --strict,scripts/lint_mermaid.py,tools/lint_hatch_matrix.py,tools/lint_release_workflows.py,tools/lint_workflow_pins.py— all passpytest— 1021 passed, 29 skipped