Skip to content

Add version navigation system for multi-version documentation (2.13-4.0+)#64

Draft
Copilot wants to merge 5 commits intomasterfrom
copilot/organize-dynamo-version-content
Draft

Add version navigation system for multi-version documentation (2.13-4.0+)#64
Copilot wants to merge 5 commits intomasterfrom
copilot/organize-dynamo-version-content

Conversation

Copy link
Contributor

Copilot AI commented Jan 26, 2026

Documentation covers Dynamo 2.13-4.0+ but lacks version guidance for users visiting from different Dynamo versions. Key differences include .NET runtime changes (4.8→8→10), Python engine defaults (IronPython2→PythonNet3), and package compatibility breaks.

Changes

Core Reference Documents

  • VERSION_GUIDE.md: Version matrix, migration paths, runtime differences, host integration table
  • CONTRIBUTING_VERSION_GUIDE.md: Maintainer guidelines for marking version-specific content
  • IMPLEMENTATION_SUMMARY.md: Technical implementation details

Version Indicators Added

Using GitBook native hint syntax at strategic decision points:

  • Entry points: Homepage, navigation, introduction (3 files)
  • Package management: Installation, compatibility warnings (2 files)
  • Developer guides: Migration guides with version badges for 2.x/3.x/4.x (4 files)
  • Python documentation: Engine version differences (IronPython2 vs PythonNet3)
  • Setup & host integration: Version-specific installation notes

Example

{% hint style="warning" %}
**Package Compatibility**: Packages built for different Dynamo versions may not be compatible due to runtime changes (.NET 4.8 → .NET 8 → .NET 10). Check for version-specific builds.
{% endhint %}

Approach

Unified documentation tree with inline version markers rather than separate version branches. Minimizes maintenance overhead while providing clear version context at decision points.

Stats

  • 17 files modified (3 new, 14 updated)
  • 344 lines added
  • 11 cross-references to central version guide
Original prompt

This is the learning material repo for Dynamo Visual Programming, which deployed to Gitbook runtime. However all the markdown files in this repo is a mix of content reflecting facts for the range of Dynamo versions from v2.13.0 to v4.0.0 (latest). Please suggest changes to better organize this repo considering currently users are going to visit a single Gitbook site entry from varies Dynamo versions.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 4 commits January 26, 2026 12:08
…umentation

Co-authored-by: QilongTang <3942418+QilongTang@users.noreply.github.com>
…pages

Co-authored-by: QilongTang <3942418+QilongTang@users.noreply.github.com>
Co-authored-by: QilongTang <3942418+QilongTang@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve organization of markdown files by Dynamo version Add version navigation system for multi-version documentation (2.13-4.0+) Jan 26, 2026
Copilot AI requested a review from QilongTang January 26, 2026 12:13
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