Skip to content

RELEASENOTES.md

Latest commit

 

History

History
145 lines (100 loc) · 4.56 KB

RELEASENOTES.md

File metadata and controls

145 lines (100 loc) · 4.56 KB

MICOS-2024 v1.1.0 Release Notes

Release Date: 2025-04-16

🎉 Highlights / 亮点

English

This release represents a major milestone in documentation quality and user experience for MICOS-2024. We've completely restructured our documentation to provide bilingual (English/Chinese) support with professional-grade guides for installation, configuration, and troubleshooting.

中文

本次发布代表了 MICOS-2024 文档质量和用户体验的重大里程碑。我们完全重组了文档，提供双语（中英文）支持，以及专业级的安装、配置和故障排除指南。

🚀 New Features / 新功能

Documentation Overhaul / 文档重构

English Documentation

  • Complete restructuring with task-oriented organization
  • Five new comprehensive guides: Installation, Configuration, Troubleshooting, FAQ, and API Reference
  • Bilingual support with full English and Chinese versions
  • Improved navigation with cross-referenced documents
  • Real-world examples with actual parameters

中文文档

  • 完整重组，采用任务导向的组织结构
  • 五篇全新综合指南：安装、配置、故障排除、FAQ 和 API 参考
  • 双语支持，提供完整的中英文版本
  • 改进导航，带交叉引用的文档
  • 真实示例，使用实际参数

Configuration Improvements / 配置改进

  • Enhanced configuration validation with detailed error messages
  • New configuration templates with inline documentation
  • Variable substitution support for cleaner configurations

🔧 Improvements / 改进

User Experience / 用户体验

  • Clearer installation instructions for all platforms
  • Comprehensive troubleshooting guides with diagnostic flowcharts
  • Quick start guides for common use cases
  • Performance benchmarks and recommendations

Documentation Quality / 文档质量

  • Professional writing standards throughout
  • Consistent formatting and structure
  • Better code examples with explanations
  • Cross-references between related topics

📚 Documentation Additions / 文档新增

New Documents / 新增文档

English 中文 Description
docs/en/index.md docs/zh/index.md Documentation portal
docs/en/installation.md docs/zh/installation.md Complete installation guide
docs/en/configuration.md docs/zh/configuration.md Configuration reference
docs/en/taxonomic-profiling.md - Taxonomic profiling details
docs/en/functional-profiling.md - Functional annotation guide
docs/en/diversity-analysis.md - Diversity analysis guide
docs/en/troubleshooting.md docs/zh/troubleshooting.md Comprehensive troubleshooting
docs/en/faq.md docs/zh/faq.md Frequently asked questions
docs/en/api-reference.md - CLI API reference

⚠️ Breaking Changes / 破坏性变更

None - This is a documentation-focused release with no breaking changes to the analysis pipeline or API.

无 - 这是一个以文档为重点的发布，对分析流程或 API 没有破坏性变更。

🔄 Migration Guide / 迁移指南

From v1.0.0

No migration needed. Simply pull the latest version:

git pull origin main

📊 System Requirements / 系统要求

No changes from v1.0.0:

Component Minimum Recommended
OS Linux/macOS Linux (Ubuntu 20.04+)
CPU 4 cores 16+ cores
RAM 16 GB 32+ GB
Storage 200 GB 700+ GB SSD

🙏 Contributors / 贡献者

  • MICOS-2024 Team

📞 Support / 支持

Channel Link
English Issues https://github.com/BGI-MICOS/MICOS-2024/issues
中文讨论 https://github.com/BGI-MICOS/MICOS-2024/discussions
Documentation https://github.com/BGI-MICOS/MICOS-2024/tree/main/docs

📝 Notes / 说明

For New Users / 新用户须知

For Existing Users / 现有用户须知

  • Documentation has been restructured - update your bookmarks
  • All existing configurations remain compatible
  • No changes to CLI commands or API

Full Changelog: CHANGELOG.md | CHANGELOG.zh.md

Thank you for using MICOS-2024!
感谢您使用 MICOS-2024！