Skip to content

docs: Hub-based architecture README overhaul #107

Description

@JusterZhu

Summary

Both README.md and README_zh.md have been updated to reflect the new Hub-based interactive sample browser architecture. This issue serves as a tracking card for the documentation changes and any follow-up improvements.

Completed (PR #106)

  • Rewrite repository structure to match current Hub + Samples layout
  • Update .NET version from 8.0 to 10.0
  • Replace old start.cmd/oss_start.cmd with Run.cmd/Run.ps1 instructions
  • Add interactive sample browser menu documentation
  • Add sample catalog table with all 9 samples
  • Document ISample interface and contribution guidelines
  • Update Chinese README (README_zh.md) in sync

Potential Follow-ups

  • Add a GIF/screenshot of the Hub interactive menu to the README
  • Document each sample's CleanPaths and expected output in more detail
  • Add troubleshooting section for common issues (e.g., server port conflicts)
  • Document the appsettings.json configuration options
  • Add a contribution quick-start for adding a new sample from scratch

Related

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions