Skip to content

Conversation

@houseme
Copy link
Contributor

@houseme houseme commented Oct 17, 2025

…e README

  • Move root examples/ contents into docs/examples/docker/.
  • Update docs/examples/README.md to add migration note, new docker/ entry and usage examples.
  • Replace references from examples/ to docs/examples/docker/ where applicable.
  • Reminder: verify CI and external links still point to the correct paths.

Type of Change

  • New Feature
  • Bug Fix
  • Documentation
  • Performance Improvement
  • Test/CI
  • Refactor
  • Other:

Related Issues

Summary of Changes

Checklist

  • I have read and followed the CONTRIBUTING.md guidelines
  • Passed make pre-commit
  • Added/updated necessary tests
  • Documentation updated (if needed)
  • CI/CD passed (if applicable)

Impact

  • Breaking change (compatibility)
  • Requires doc/config/deployment update
  • Other impact:

Additional Notes


Thank you for your contribution! Please ensure your PR follows the community standards (CODE_OF_CONDUCT.md) and sign the CLA if this is your first contribution.

…e README

- Move root `examples/` contents into `docs/examples/docker/`.
- Update `docs/examples/README.md` to add migration note, new `docker/` entry and usage examples.
- Replace references from `examples/` to `docs/examples/docker/` where applicable.
- Reminder: verify CI and external links still point to the correct paths.
@houseme houseme requested a review from Copilot October 17, 2025 08:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the repository structure by moving Docker examples from the root examples/ directory to docs/examples/docker/ and updating all related documentation and references.

  • Move Docker deployment examples to a more organized location under documentation
  • Update README files to reflect the new directory structure
  • Fix broken relative links and references throughout the documentation

Reviewed Changes

Copilot reviewed 4 out of 8 changed files in this pull request and generated 6 comments.

File Description
docs/examples/docker/README.md Updated relative links to match new directory structure and improved formatting
docs/examples/README.md Added docker subdirectory section with usage examples and migration notes
README_ZH.md Line formatting improvements for better readability
README.md Line formatting improvements for better readability

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@houseme houseme merged commit 4168e6c into main Oct 17, 2025
14 checks passed
@houseme houseme deleted the feature/improve-examples branch October 17, 2025 09:17
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.

1 participant