Skip to content

docs: refactor 5 GeneralUpdate component docs with unified template#77

Merged
JusterZhu merged 3 commits into
mainfrom
feature/add-auth-providers
Jun 3, 2026
Merged

docs: refactor 5 GeneralUpdate component docs with unified template#77
JusterZhu merged 3 commits into
mainfrom
feature/add-auth-providers

Conversation

@JusterZhu

Copy link
Copy Markdown
Collaborator

Summary

Unified documentation structure for GeneralUpdate.Core, GeneralUpdate.Bowl, GeneralUpdate.Differential, GeneralUpdate.Drivelution, and GeneralUpdate.Extension across zh-Hans and en locales.

Changes

Each component doc now follows a consistent 6-section template:

§ Section Content
1 Component Overview Capabilities table, business problems, use cases
2 Feature List Feature name, description, type (Core/Extended), required, notes
3 API Reference 3 tables: Props, Instance Methods, Callback Events
4 Advanced Examples Extension points overview + multiple scenario examples
5 Basic Examples Quick start → basic params → production-ready
6 Global Configuration Platform differences, logging config, manifest config

Additional improvements:

  • Added inline metadata block (namespace, entry point, NuGet package) directly below title
  • Removed redundant duplicate fields from Environment & Dependencies section
  • Removed dotnet add package install commands (redundant with metadata)
  • Merged UpgradeHub content into GeneralUpdate.Core docs
  • Updated sidebar to remove standalone UpgradeHub entry

Files changed:

  • 15 doc files (5 components × 3 locales: docs/doc/, i18n/en/, i18n/zh-Hans/)
  • 1 sidebar config (sidebars.js)

🤖 Generated with Claude Code

JusterZhu and others added 2 commits June 3, 2026 22:39
>
> Reflects rename in GeneralUpdate Core library.
>
> Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Unified documentation structure for Core, Bowl, Differential, Drivelution,
and Extension across zh-Hans and en locales. Each doc now follows:

  §1 Component Overview with capabilities table, business problems & use cases
  §2 Feature list (Core/Extended classification)
  §3 API reference — 3 tables: Props, Methods, Callback Events
  §4 Advanced examples with extension points overview
  §5 Basic examples (quick start → basic params → production ready)
  §6 Global configuration

Additional changes:
- Added inline metadata (namespace, entry point, NuGet package) below title
- Removed redundant duplicate fields from Environment & Dependencies section
- Removed 'dotnet add package' install commands (redundant with metadata)
- Merged UpgradeHub content into GeneralUpdate.Core docs
- Updated sidebar to remove standalone UpgradeHub entry

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 3, 2026 16:19
@JusterZhu JusterZhu removed the request for review from Copilot June 3, 2026 16:22
@JusterZhu JusterZhu self-assigned this Jun 3, 2026
@JusterZhu JusterZhu added the documentation Improvements or additions to documentation label Jun 3, 2026
@JusterZhu JusterZhu linked an issue Jun 3, 2026 that may be closed by this pull request
…version)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@JusterZhu JusterZhu merged commit 085fb35 into main Jun 3, 2026
2 checks passed
@JusterZhu JusterZhu deleted the feature/add-auth-providers branch June 3, 2026 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: 重构 GeneralUpdate 五大组件文档

1 participant