docs: expand information on plugin placement in layout standard#555
Open
docs: expand information on plugin placement in layout standard#555
Conversation
dopenguin
requested review from
oeninghe-dataport and
warm-coolguy
as code owners
|
dopenguin
force-pushed
the
vue3/documentation-plugin-placement
branch
5 times, most recently
from
61b9e40 to
cd50403
Compare
dopenguin
force-pushed
the
vue3/documentation-plugin-placement
branch
from
cd50403 to
7652df5
Compare
warm-coolguy
requested changes
Mar 30, 2026
Member
There was a problem hiding this comment.
The rendered docs show that the links do not resolve as intended. This is probably due to the field renderType not being defined in PluginOptions.
It is furthermore confusing that one layouting system is explained as part of parameters and one as part of the type.
Proposed solution: Introductory text explains that there's two layouting systems available and briefly explains their difference. Parameters to PluginOptions further elaborate, and missing renderType is added.
Option: PluginOptions could become some sort or Either type, since either displayComponent/layoutTag are relevant, or renderType is. However, I don't know how to write this ad hoc.
dopenguin
force-pushed
the
vue3/documentation-plugin-placement
branch
from
7652df5 to
97b43a4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add additional information on how (custom) plugins may be played in
layout: 'standard'.Instructions for local reproduction and review
Read it.