Skip to content

Improve @plone/client documentation #7947

@stevepiercy

Description

@stevepiercy

This issue pertains to @plone/cllient. It has several parts that can be worked on in separate pull requests. The affected files are primarily in https://github.com/plone/volto/tree/main/docs/source/client, but might be in other parts of the Volto documentation, too. If you find other places, please add them to this issue.

  • Remove any reference to TanStack Query and its terminology, including mutators, useQuery, hooks, and any other of its terms. This task requires that the remaining narrative text is accurate, has correct English grammar, and makes sense to the reader.
  • For HTTP API calls, use the lovely sphinxcontrib.httpexample extension, thanks to @datakurre and @Hrittik20's work. This requires a configuration change to the Volto documentation's file docs/source/conf.py, adding it as a dependency to build the docs, and then implement HTTP requests following the examples from sphinxcontrib.httpexample's documentation.
  • Forward port the final result to the seven branch.

Metadata

Metadata

Assignees

No one assigned

    Projects

    Status

    New

    Status

    Needs discussion

    Status

    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions