Skip to content

Track: docs - Common Recipes section for well-known files (#2527) #2537

Description

@coderabbitai

Summary

Tracking issue for PR #2527, which adds a Common Recipes section to the README demonstrating how to detect security.txt, and other well-known URIs using httpx's composable primitives (-path, -mc, -mct, -mr).

Background

Per maintainer feedback in #2472 and the follow-up discussion in #2468 (comment: #2468 (comment)), this PR turns the previously closed PR #2472 (which proposed adding per-file flags) into documentation showing recipes for well-known files, aligning with httpx's philosophy of composability over specialized flags.

Scope / Affected areas

  • README.md: new "Common Recipes" section inserted before the "# Notes" section, with one-liner examples and links to RFC 9116 (security.txt) and the IANA well-known URIs registry.

Acceptance criteria

  • Common Recipes section merged into README.md
  • Wording/format reviewed and iterated on as needed
  • Examples verified to work against httpx

Links

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions