Skip to content

[v11] Remove ScopedBlocks from the docs#30855

Merged
ptgott merged 5 commits intobranch/v11from
paul.gottschling/2023-08-21-sb-v11
Aug 24, 2023
Merged

[v11] Remove ScopedBlocks from the docs#30855
ptgott merged 5 commits intobranch/v11from
paul.gottschling/2023-08-21-sb-v11

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Aug 22, 2023

Backports a series of PRs removing ScopedBlocks from the documentation:

Also removes the remaining ScopedBlocks from v13 of the docs.

ptgott added 4 commits August 21, 2023 17:37
Backports #30616

* Replace multi-line ScopedBlocks with Tabs

Contributes to #30268

The documentation scope switcher tends to confuse users, and the
ScopedBlock component hides docs content based on the scope switcher. To
help remove ScopedBlocks from the docs site, this change replaces
multi-line ScopedBlocks with Tabs components if they include variations
for different scopes.

While most multi-line ScopedBlocks function like Tabs, there are a few
edge cases, which this change addresses individually.

Note that this change does not intend to remove all ScopedBlocks that
are placed inline within a paragraph. That will be the goal of a
separate change.

* Remove more ScopedBlocks (#30623)

This builds on the work done in #30616 and contributes to #30616.
Backports #30769

In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was
because most `ScopedBlocks` included variations on the same text for
multiple scopes, and replacing them with `TabItem`s was straightforward.
However, some replacements included only a single `TabItem`, which
displays awkwardly in the docs.

This change removes `Tabs` components with only one `TabItem`, replacing
them with body text.
@ptgott ptgott force-pushed the paul.gottschling/2023-08-21-sb-v11 branch from cc2bbf7 to caafece Compare August 22, 2023 20:03
@ptgott ptgott added this pull request to the merge queue Aug 24, 2023
Merged via the queue into branch/v11 with commit 4e981b4 Aug 24, 2023
@ptgott ptgott deleted the paul.gottschling/2023-08-21-sb-v11 branch August 24, 2023 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants