Skip to content

docs: better multiversion support for docs v2#2568

Open
git-nandor wants to merge 1 commit into
rework-documentationfrom
INSTUI-5031_better_multiversion_support_for_docs_v2
Open

docs: better multiversion support for docs v2#2568
git-nandor wants to merge 1 commit into
rework-documentationfrom
INSTUI-5031_better_multiversion_support_for_docs_v2

Conversation

@git-nandor
Copy link
Copy Markdown
Contributor

@git-nandor git-nandor commented May 27, 2026

INSTUI-5031

Summary

  • Moves the component version (minor version) selector from the side nav to the component pages, displayed alongside the Theme selector
  • The Component version and Theme selectors are now only rendered on Components pages
  • The v11.6 option in the Component version Select is labeled v11.6 (legacy theming)
  • Restores the full library version display in the side nav header
  • Legacy Theme Overrides page always redirects to v11.6
  • New Theme Overrides page always redirects to v11.7
  • Adds an info alert on all non-component pages explaining that the content reflects the latest versioning
  • Modify New theme overrides page "13. Independent overrides for child parts of compound components" section
  • Adds a new "Component versioning" guide page

Co-Authored-By: 🤖 Claude

@git-nandor git-nandor self-assigned this May 27, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://instructure.design/pr-preview/pr-2568/

Built to branch gh-pages at 2026-06-03 08:45 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

github-actions Bot pushed a commit that referenced this pull request May 27, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2026

Visual regression report

No changes.

Status Count
Unchanged 32
Changed 0
New 0
Removed 0

📊 View full report

Baselines come from the visual-baselines branch. They refresh on every merge to master.

@git-nandor git-nandor force-pushed the INSTUI-5031_better_multiversion_support_for_docs_v2 branch 2 times, most recently from 817d7d2 to d14ada1 Compare May 27, 2026 18:02
@git-nandor git-nandor force-pushed the rework-documentation branch from cf96591 to e713885 Compare May 28, 2026 07:53
@git-nandor git-nandor force-pushed the INSTUI-5031_better_multiversion_support_for_docs_v2 branch from d14ada1 to c60e824 Compare May 28, 2026 07:56
@git-nandor git-nandor marked this pull request as ready for review May 28, 2026 07:56
Copy link
Copy Markdown
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The "If you are viewing the v11.7 version, switch to v11.6 to see the examples working correctly." text in the legacy/new theme overrides is not needed anymore since the switch is automatic.
  • The message "This page always displays the latest version of the documentation" is not clear what it means. I would rephrase it to "This page is made for the latest version (v${major.minor})) of InstUI). Also the linked page https://instructure.design/pr-preview/pr-2568/v11_7/multi-version-system is way too detailed for our users, can you make a new page under Guides that explains the multi version stuff for users? We just need that components are now versioned, the import paths, and what versions work with which theming engine.
  • I would not include the Component version selector for non-component pages where it does nothing
  • +1: How about displaying components with the "Light" theme when switching to v11.7, since this is now the recommended theme?

@git-nandor git-nandor force-pushed the rework-documentation branch from e713885 to ced0fb5 Compare June 2, 2026 12:37
@git-nandor git-nandor force-pushed the INSTUI-5031_better_multiversion_support_for_docs_v2 branch from c60e824 to 7e3bad3 Compare June 3, 2026 08:25
@git-nandor git-nandor requested a review from matyasf June 3, 2026 08:25
@git-nandor git-nandor force-pushed the INSTUI-5031_better_multiversion_support_for_docs_v2 branch from 7e3bad3 to a04f8e7 Compare June 3, 2026 08:41
Copy link
Copy Markdown
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, I like these changes a lot!

---
title: Component versioning
category: Guides
order: 5
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is an important document, it should be #2, right after the "Getting started" menu point. but its not that important

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