Skip to content

SCRUM-8: Improve discoverability documentation and AI readiness#125

Merged
vishalanandl177 merged 1 commit into
mainfrom
SCRUM-8-P0-Improve-discoverability-documentation-and-AI-readiness
Jul 3, 2026
Merged

SCRUM-8: Improve discoverability documentation and AI readiness#125
vishalanandl177 merged 1 commit into
mainfrom
SCRUM-8-P0-Improve-discoverability-documentation-and-AI-readiness

Conversation

@vishalanandl177

Copy link
Copy Markdown
Owner

Summary

  • Reposition README and PyPI metadata around "The production standard for DRF API observability" while keeping setup examples concrete and safe.
  • Add llms.txt plus Read the Docs pages for quickstart recipes, AI assistant guidance, comparison/migration, and tutorials/community snippets.
  • Align Read the Docs configuration with explicit v2 Sphinx settings, warnings-as-failures, and hosted llms.txt output.

Objective

This PR is meant to make main up 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 -v
  • python test_runner_simple.py
  • python -m sphinx -W -b html docs docs\_build\html
  • Generated Read the Docs files verified, including docs/_build/html/llms.txt
  • python -m build --sdist --wheel
  • python -m twine check dist/*
  • Confirmed llms.txt is included in the source distribution

Notes

Pre-existing untracked local files were intentionally left out of this branch: DRF-API-Logger-Strategic-Roadmap.md, docs/superpowers/, and scripts/.

@vishalanandl177
vishalanandl177 merged commit 9895a9a into main Jul 3, 2026
6 checks passed
@vishalanandl177
vishalanandl177 deleted the SCRUM-8-P0-Improve-discoverability-documentation-and-AI-readiness branch July 3, 2026 19:19

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/quickstart.rst
.. code-block:: python

DRF_API_LOGGER_ENABLE_TRACING = True
DRF_API_LOGGER_TRACING_ID_HEADER_NAME = "X-Request-ID"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

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.

1 participant