docs: add comprehensive version history and repository transition guide #28
Conversation
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
Added detailed documentation explaining: 📊 Version History & Repository Transition: - Current mono-repository architecture starting from v0.68.0 - Evolution from multi-repo to mono-repo architecture - Unified versioning across all components 🔍 Version Gap Explanation (v0.59.0 - v0.67.0): - Why Node/Node-exe components appear to skip versions 0.59.0-0.67.0 - C-API continued releasing during this period while Node remained stable at v0.58.0 - Clear timeline of component evolution during multi-repo period 📍 Legacy Version Navigation: - C-API versions ≤ 0.67.0: Available in k-nuth/c-api repository - Node & Node-exe versions ≤ 0.58.0: Available in respective repositories - All versions ≥ 0.68.0: Available in this mono-repository ✨ Benefits Documentation: - Simplified management and unified versioning - Better developer experience and dependency management - Improved coordination between components This documentation helps users understand the project's evolution and locate appropriate versions for their needs.
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.
📋 Overview
This PR adds comprehensive documentation to explain the Knuth project's evolution from a multi-repository to mono-repository architecture, helping users understand version numbering and locate appropriate releases for their needs.
📊 New Documentation Section: "Version History & Repository Transition"
Added Content:
🔄 Repository Architecture Evolution
🔍 Version Gap Explanation (v0.59.0 - v0.67.0)
📍 Legacy Version Navigation Guide
k-nuth/c-api✨ Benefits of Mono-repository Architecture
🎯 Why This Documentation Matters
📍 Placement
The new section is strategically placed after "Releases" and before "Key Features" to provide version context before diving into technical details.
🔍 Content Quality
📝 Impact
This documentation will help both new and existing users:
🧪 Testing
The documentation has been reviewed for: