Skip to content

docs(vc-shell): add components, composables, plugins to nav order#59

Merged
maksimzinchuk merged 1 commit into
docs/vc-shell-integrationfrom
feat/plugins-nav
May 13, 2026
Merged

docs(vc-shell): add components, composables, plugins to nav order#59
maksimzinchuk merged 1 commit into
docs/vc-shell-integrationfrom
feat/plugins-nav

Conversation

@maksimzinchuk
Copy link
Copy Markdown
Collaborator

@maksimzinchuk maksimzinchuk commented May 12, 2026

Summary

Update the manual vc-shell/.pages nav-list to include the three auto-generated top-level folders that the sync-docs.yml CI workflow populates: components, composables, plugins. Restores their position between concepts and guides.

⚠ Merge order

Must land AFTER the sync-docs.yml auto-PR (created by vc-shell-docs-bot with the auto-generated label) creates the components/, composables/, and plugins/ folders in vc-docs. If this lands first, awesome-pages errors with:

NavEntryNotFound: Nav entry "components" not found.
[custom-apps-development/vc-shell/.pages]

because vc-shell/.pages references folders that don't yet exist on disk.

This PR is intentionally opened as draft until the auto-sync lands. Mark ready for review after the first auto-sync PR is merged.

Final sidebar once all PRs have landed

VC-Shell
├── Introduction
├── Getting Started
├── Concepts
├── Components    ← auto from vc-shell sources
├── Composables   ← auto from vc-shell sources
├── Plugins       ← auto from vc-shell sources (new in vc-shell #223)
├── Guides
└── Reference

Related

Test plan

  • Wait for first auto-sync PR to land in main
  • Mark this PR ready for review
  • mkdocs build — verify nav resolves; sidebar shows VC-Shell → Components/Composables/Plugins peers
  • CI green

@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.

@maksimzinchuk maksimzinchuk force-pushed the docs/vc-shell-phase-0-migration branch from 9e30589 to 9409492 Compare May 12, 2026 12:37
@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): add plugins to nav order docs(vc-shell): add components, composables, plugins to nav order May 12, 2026
@maksimzinchuk maksimzinchuk reopened this May 12, 2026
@maksimzinchuk maksimzinchuk changed the base branch from docs/vc-shell-phase-0-migration 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
Update the manual vc-shell/.pages nav-list to include the three
auto-generated top-level folders that the sync-docs CI workflow
populates: components, composables, plugins. Restores their position
between concepts and guides.

MERGE ORDER: must land AFTER the sync-docs.yml auto-PR creates the
components/, composables/, and plugins/ folders. If this lands first,
awesome-pages errors with NavEntryNotFound because vc-shell/.pages
would reference folders that don't yet exist.

Final sidebar after both have landed:
  VC-Shell
  ├── Introduction
  ├── Getting Started
  ├── Concepts
  ├── Components   ← auto from vc-shell sources
  ├── Composables  ← auto from vc-shell sources
  ├── Plugins      ← auto from vc-shell sources (new in #223)
  ├── Guides
  └── Reference
@maksimzinchuk maksimzinchuk marked this pull request as ready for review May 13, 2026 12:15
@maksimzinchuk maksimzinchuk merged commit 04d5ac9 into docs/vc-shell-integration May 13, 2026
1 of 2 checks passed
@maksimzinchuk maksimzinchuk deleted the feat/plugins-nav branch May 13, 2026 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants