SCRUM-8: Improve discoverability documentation and AI readiness#125
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7fb7da8849
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| .. code-block:: python | ||
|
|
||
| DRF_API_LOGGER_ENABLE_TRACING = True | ||
| DRF_API_LOGGER_TRACING_ID_HEADER_NAME = "X-Request-ID" |
There was a problem hiding this comment.
Document underscore header names for tracing
When users follow this upstream request-ID example, the middleware will not actually read an X-Request-ID header: Django exposes that header as HTTP_X_REQUEST_ID, and get_headers() only strips the HTTP_ prefix, leaving the key as X_REQUEST_ID. In that scenario the lookup misses and a new UUID is generated instead, so request ID propagation breaks for anyone copying the quickstart; the docs should use the underscore form the middleware expects or the code should normalize hyphenated header names.
Useful? React with 👍 / 👎.
Summary
llms.txtplus Read the Docs pages for quickstart recipes, AI assistant guidance, comparison/migration, and tutorials/community snippets.llms.txtoutput.Objective
This PR is meant to make
mainup to date as the next-task base. It does not publish a package, create a release tag, or push any new PyPI/build artifact.Validation
python -m unittest tests.test_docs_content -vpython test_runner_simple.pypython -m sphinx -W -b html docs docs\_build\htmldocs/_build/html/llms.txtpython -m build --sdist --wheelpython -m twine check dist/*llms.txtis included in the source distributionNotes
Pre-existing untracked local files were intentionally left out of this branch:
DRF-API-Logger-Strategic-Roadmap.md,docs/superpowers/, andscripts/.