Skip to content

docs(vc-shell): scaffold VC-Shell docs section (infrastructure + manual content)#57

Merged
maksimzinchuk merged 2 commits into
docs/vc-shell-integrationfrom
docs/vc-shell-phase-0-migration
May 12, 2026
Merged

docs(vc-shell): scaffold VC-Shell docs section (infrastructure + manual content)#57
maksimzinchuk merged 2 commits into
docs/vc-shell-integrationfrom
docs/vc-shell-phase-0-migration

Conversation

@maksimzinchuk
Copy link
Copy Markdown
Collaborator

@maksimzinchuk maksimzinchuk commented May 12, 2026

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 the sync-docs.yml CI workflow on each vc-shell release, which opens a separate PR labeled auto-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 for vc-shell-docs-bot and PRs labeled auto-generated.

Commit 2 — Manual narrative content

  • 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
  • reference/api/index.md and reference/modules/index.md — placeholder index pages (the AUTO siblings come from CI)
  • vc-shell/.pages and custom-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

  1. This PR (docs(vc-shell): scaffold VC-Shell docs section (infrastructure + manual content) #57) merges → infrastructure + manual content land on main. Site builds fine; components/, composables/, plugins/ paths 404 until CI auto-sync runs.
  2. vc-shell release cut (post #223 merge) → sync-docs.yml opens an auto/sync-vc-shell-<tag> PR with all AUTO content (~147 files in components/, composables/, reference/api/, reference/modules/, plugins/). Reviewer merges with the auto-generated label bypassing the guard.
  3. PR docs(vc-shell): add components, composables, plugins to nav order #59 (draft) marked ready, merged → adds components/composables/plugins to vc-shell/.pages nav order. Final sidebar takes shape.

Companion PRs

Test plan

  • mkdocs build -f platform/developer-guide/mkdocs.yml — exit 0
  • mkdocs serve — sidebar shows Introduction / Getting Started / Concepts / Guides / Reference with manual stubs. Components/Composables/Plugins absent (expected; CI populates them).
  • CI green

@maksimzinchuk maksimzinchuk added the auto-generated Generated by docs-sync automation label May 12, 2026
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

github-actions Bot added 2 commits May 12, 2026 17:32
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.
@maksimzinchuk maksimzinchuk force-pushed the docs/vc-shell-phase-0-migration branch from 9409492 to 24ccff8 Compare May 12, 2026 14:33
@maksimzinchuk maksimzinchuk changed the title docs(vc-shell): Phase 0 docs migration with awesome-pages nav docs(vc-shell): scaffold VC-Shell docs section (infrastructure + manual content) May 12, 2026
@maksimzinchuk maksimzinchuk changed the base branch from main to docs/vc-shell-integration May 12, 2026 14:42
@maksimzinchuk maksimzinchuk force-pushed the docs/vc-shell-integration branch from eeefbbb to 6be576e Compare May 12, 2026 14:43
@maksimzinchuk maksimzinchuk merged commit 2a01628 into docs/vc-shell-integration May 12, 2026
1 of 2 checks passed
@maksimzinchuk maksimzinchuk deleted the docs/vc-shell-phase-0-migration branch May 12, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-generated Generated by docs-sync automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants