Skip to content

improve pipeline for user-facing feature-specific documentation #7817

@brainwane

Description

@brainwane

This doesn't need to block this PR, but I've wondered if our propensity for linking to PEPs is the best user experience we can provide here, or if we should figure out a real documentation pipeline for Warehouse (not really counting what exists now since it's primarily developer facing documentation, not user facing) and start moving to that.

Originally posted by @dstufft in #5838

Donald, could you talk a little more about what you mean re: a documentation pipeline for user-facing docs? Right now we have:

  • packaging.python.org
  • the help/FAQ page on PyPI
  • warehouse.readthedocs.io/ which does have user-facing stuff for the API, for instance

Am I right in understanding that you want a better system for inline/contextual instructions and other docs to display within features?

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions