docs(vc-shell): scaffold VC-Shell docs section (infrastructure + manual content)#57
Merged
maksimzinchuk merged 2 commits intoMay 12, 2026
Conversation
|
|
This was referenced May 12, 2026
9e30589 to
9409492
Compare
Set up the infrastructure for framework-source documentation auto-synced
from vc-shell. Manual content (introduction, getting-started, concepts,
guides, reference/{cli,migration}) lands in a follow-up commit; AUTO
content (components, composables, reference/{api,modules}) is delivered
by the sync-docs CI workflow on each vc-shell release.
- mkdocs.yml (developer-guide): switch Custom Apps Development to a
single awesome-pages rest pattern (... | regex=^custom-apps-development/.+\.md$).
Replaces the previous 75-line manual nav enumeration. awesome-pages
walks .pages files at every level so adding new components/composables
in vc-shell sources doesn't require an mkdocs.yml edit.
- vc-shell-docs.css: Storybook iframe embeds, admonition styling, table
tweaks, frozen-version banner.
- overrides/main.html: theme override hook for the version banner.
- .github/workflows/protect-generated.yml: CI guard that blocks human
edits to AUTO-GENERATED files inside the auto-managed subtree
(components/, composables/, reference/{api,modules}/). Manual folders
(introduction/, getting-started/, guides/, reference/{cli,migration}/)
are skipped. Bypassed for vc-shell-docs-bot and PRs labeled
auto-generated.
The docs-sync CLI lives in vc-shell; on each release sync-docs.yml runs
it against this repo, commits the result, and opens an auto-PR.
Land the hand-written portion of the VC-Shell documentation: introduction,
getting-started, narrative concepts, guides placeholders, and reference
sub-sections that aren't framework-source.
AUTO-GENERATED content (components/, composables/, reference/api,
reference/modules) is intentionally NOT in this commit — it is delivered
by the sync-docs CI workflow that runs on each vc-shell release, creating
auto-PRs labeled 'auto-generated' that the protect-generated guard
bypasses.
Manual content added:
- introduction/ — overview, what-is-vc-shell, architecture-overview,
when-to-use
- getting-started/ — installation, create-your-app, project-structure,
connecting-to-platform, first-blade
- concepts/ — narrative stubs for blade navigation, modules,
extensions, layout, permissions-model, localization,
state-persistence, api-clients
- guides/ — placeholder index pages for blades, cookbook, data,
forms, modules-and-extensions, platform, troubleshooting,
ui
- reference/cli/ — api-client-generator and create-vc-app
- reference/migration/ — placeholder index
- reference/api/ and reference/modules/ — placeholder index pages
- vc-shell/.pages and custom-apps-development/.pages — manual nav
scaffolding (excludes 'components' and 'composables' entries — those
will be added in a follow-up PR after the first CI auto-sync populates
the folders)
Removes the legacy hand-curated VC-Shell pages from the previous layout
(Essentials/Usage-Guides/Plugins/Shared/UI Components, Extensibility,
How-tos, capitalized Getting-started/Guides). Replaced by the new
lowercase layout under the same parent.
9409492 to
24ccff8
Compare
eeefbbb to
6be576e
Compare
2a01628
into
docs/vc-shell-integration
1 of 2 checks passed
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.
Summary
Land the infrastructure and manual narrative content for the VC-Shell developer documentation under
custom-apps-development/vc-shell/. The auto-synced framework reference docs (components, composables, reference/api, reference/modules) are intentionally NOT in this PR — they are delivered by thesync-docs.ymlCI workflow on each vc-shell release, which opens a separate PR labeledauto-generated.What's in this PR
Commit 1 — Infrastructure
mkdocs.yml(developer-guide): single awesome-pages rest pattern... | regex=^custom-apps-development/.+\.md$replaces the previous 75-line manual enumeration of VC-Shell pages.vc-shell-docs.css: Storybook iframe embeds, admonition styling, table tweaks, frozen-version banner.overrides/main.html: theme hook for the frozen-version banner..github/workflows/protect-generated.yml: CI guard that blocks human edits to AUTO-GENERATED files. Skips manual folders (introduction/, getting-started/, guides/, reference/cli/, reference/migration/). Bypassed forvc-shell-docs-botand PRs labeledauto-generated.Commit 2 — Manual narrative content
introduction/— overview, what-is-vc-shell, architecture-overview, when-to-usegetting-started/— installation, create-your-app, project-structure, connecting-to-platform, first-bladeconcepts/— narrative stubs for blade-navigation, modules, extensions, layout, permissions-model, localization, state-persistence, api-clientsguides/— placeholder index pages for blades, cookbook, data, forms, modules-and-extensions, platform, troubleshooting, uireference/cli/— api-client-generator and create-vc-appreference/migration/— placeholderreference/api/index.mdandreference/modules/index.md— placeholder index pages (the AUTO siblings come from CI)vc-shell/.pagesandcustom-apps-development/.pages— manual nav scaffolding (excludes components/composables/plugins entries — added in follow-up docs(vc-shell): add components, composables, plugins to nav order #59 after CI auto-sync populates the folders)Also removes the legacy hand-curated VC-Shell pages from the previous layout (Essentials/Usage-Guides/Plugins/Shared/UI Components, Extensibility, How-tos, capitalized Getting-started/Guides).
Sequence
components/,composables/,plugins/paths 404 until CI auto-sync runs.sync-docs.ymlopens anauto/sync-vc-shell-<tag>PR with all AUTO content (~147 files in components/, composables/, reference/api/, reference/modules/, plugins/). Reviewer merges with theauto-generatedlabel bypassing the guard.vc-shell/.pagesnav order. Final sidebar takes shape.Companion PRs
pluginscategory in docs-sync.vc-shell/.pagesnav order.Test plan
mkdocs build -f platform/developer-guide/mkdocs.yml— exit 0mkdocs serve— sidebar shows Introduction / Getting Started / Concepts / Guides / Reference with manual stubs. Components/Composables/Plugins absent (expected; CI populates them).