feat: add document v2 dev docs - #2434
Open
Lars Kemper (larskemper) wants to merge 5 commits into
Open
Conversation
Developer Docs healthcheckStatus: Completed with |
Lars Kemper (larskemper)
requested review from
a team,
Simon Fiebranz (CR0YD),
Dennis Garding (DennisGarding),
Malte Janz (MalteJanz),
Juri Himmelreich (jc-sw-git),
Jozsef Damokos (jozsefdamokos) and
Nikolas Evers (vintagesucks)
and removed request for
a team
August 7, 2026 13:26
Lars Kemper (larskemper)
force-pushed
the
docs/document-v2
branch
from
August 10, 2026 05:31
bb32394 to
c3d06bd
Compare
Lars Kemper (larskemper)
marked this pull request as ready for review
August 10, 2026 05:31
Contributor
📊 Documentation Impact Analyzer
Reasons
|
Dennis Garding (DennisGarding)
approved these changes
Aug 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds developer documentation for the new Document System (v2) across concepts and extension guides, while marking the legacy v1 plugin documentation as deprecated ahead of its removal.
Changes:
- Deprecate existing v1 plugin document pages and point readers to v2 concept + guides.
- Introduce new v2 documentation: concept pages (overview/architecture/extension points) and plugin/app extension guides.
- Extend spellcheck wordlist for new technical terms used in the docs.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| guides/plugins/plugins/checkout/document/index.md | Renames v1 page and adds deprecation notice pointing to v2 docs. |
| guides/plugins/plugins/checkout/document/add-custom-document.md | Adds v1 deprecation notice with links to v2 docs. |
| guides/plugins/plugins/checkout/document/add-custom-document-type.md | Adds v1 deprecation notice with links to v2 docs. |
| guides/plugins/plugins/checkout/document-v2/index.md | New landing page for v2 plugin guides with PageRef navigation. |
| guides/plugins/plugins/checkout/document-v2/add-a-document-type.md | New guide for adding a v2 document type via tagged services + templates. |
| guides/plugins/plugins/checkout/document-v2/add-a-format-renderer.md | New guide for adding/overriding v2 renderers via tag priority. |
| guides/plugins/plugins/checkout/document-v2/customize-document-data-and-templates.md | New guide for data providers and template overrides in v2. |
| guides/plugins/apps/checkout/document.md | New guide describing declarative v2 document extension via apps (manifest/templates/scripts). |
| concepts/commerce/checkout-concept/document/index.md | New v2 concept overview (includes rollout timeline + ADR links). |
| concepts/commerce/checkout-concept/document/architecture.md | New detailed architecture page (pipeline, registries, formats, storage). |
| concepts/commerce/checkout-concept/document/extension-points.md | New extension-points overview linking to plugin/app guides. |
| .wordlist.txt | Adds spellcheck exceptions for new terminology used in the new docs. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Lars Kemper (larskemper)
force-pushed
the
docs/document-v2
branch
from
August 10, 2026 05:38
c3d06bd to
7ebeff1
Compare
Micha Hobert (Isengo1989)
left a comment
Micha Hobert (Isengo1989)
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the PR, one idea tho, instead of having multiple submenu entries on the top level, why don't we move it to one "Document" menu and guide the user from there. Less noise and cleaner IMO.
Also I think it is a good idea to call it "Legacy" and not v1, as it is per se not versioned and also can not be recognized by v1 etc. in any classname etc.
WDYT ?
Member
Author
Micha Hobert (@Isengo1989) Sounds good. I have adjusted it and also switched from "v1" to "legacy" in the content. |
Micha Hobert (Isengo1989)
requested changes
Aug 13, 2026
Micha Hobert (Isengo1989)
added
the
Undocumented Feature
Co-authored-by: Micha Hobert <m.hobert@shopware.com>
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
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.
part of shopware/shopware#16153