Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Refactors and reorganizes the bundle documentation into a structured chapter layout (Architecture / Installation / Extending / Development) and updates the root README to point to the new docs.
Changes:
- Introduces a new
doc/README.mdlanding page with a chapter-based documentation index. - Replaces the former
doc/10_Extending_Studio/*documentation with a reorganizeddoc/03_Extending/*structure and new/updated chapter README files. - Updates the repository
README.mdwith a features overview and new documentation links.
Reviewed changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
README.md |
Updates project overview and doc links (but currently documents an incorrect OpenAPI spec URL). |
doc/README.md |
New docs landing page with the new chapter navigation. |
doc/01_Architecture_Overview/* |
Adds front matter and refines architecture documentation content/structure. |
doc/02_Installation_and_Configuration/* |
Adds front matter and reorganizes installation/config docs (OpenAPI UI availability needs clarification). |
doc/03_Extending/* |
Rewrites and reorganizes extension-point docs into a consistent chapter structure. |
doc/04_Development_Details/* |
Adds front matter and improves developer/testing docs (minor heading capitalization issue). |
doc/10_Extending_Studio/* |
Removes legacy extending docs in favor of the new structure. |
Comments suppressed due to low confidence (4)
doc/02_Installation_and_Configuration/README.md:84
/pimcore-studio/api/docsis documented as the OpenAPI UI, but the route is only enabled in thedevenvironment (condition: "'dev' === '%kernel.environment%'"). Please clarify that Swagger UI is dev-only and that/pimcore-studio/api/docs/jsonis the stable endpoint for fetching the spec in all environments.
doc/04_Development_Details/02_API_Testing.md:6- Heading casing is inconsistent with the front matter title (
API Testing). Consider renaming# Api Testingto# API Testingfor consistency and correct acronym capitalization.
doc/03_Extending/11_Perspectives/README.md:17 - Section heading grammar:
How to add a custom context menu permissionsshould use singularpermission(or rephrase) to match the subsequent text about adding a single permission.
doc/03_Extending/11_Perspectives/README.md:36 - Grammar:
once its enabledshould beonce it's enabled(contraction for “it is”).
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes in this pull request
Resolves #350
Additional info
Restructure and add missing documentation parts