The cross-site API reference (docs/api.md) embeds Redoc inline. Redoc is a full-width, three-pane application, but the Material theme constrains page content to a narrow centered column, so the three panes are crushed together and the reference is effectively unusable (the response-samples panel wraps about one character per line).

Proposed resolution

  • Give the API page room: hide the left navigation and right table of contents on docs/api.md and drop the content max-width for that page only (scoped to pages that contain a Redoc element), so the inline reference renders full-width.
  • Add a standalone, chrome-free full-page reference at docs/api-reference.html (Redoc on its own page), linked from the API page with a small "full-page reference" link.
  • Exclude docs/api-reference.html from cspell (HTML boilerplate, not prose) and enable the attr_list markdown extension for the link attributes.

Documentation tooling only; no functional code changes.

Issue fork pdv-3593454

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

mably created an issue. See original summary.

mably’s picture

Status: Active » Needs review
mably’s picture

Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • mably committed b0a3d7d9 on 1.x
    task: #3593454 Make the cross-site API reference readable (full-width...

  • mably committed 73d16ad4 on 1.x
    Issue #3593454 by mably: Use a source-relative docs link so the strict...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.