1 Commits

Author SHA1 Message Date
Dizhan Xue
9b3ca145b6
docs: refresh bilingual readme showcases (#795)
## Summary

The README showcase now highlights three complete projects: THRESHOLD,
Raven RSI, and Raven's product launch kit. Each project pairs a concise
description with hosted videos, posters, presentations, and website or
README previews.

- Polish the English and Chinese titles, descriptions, and media labels.
- Preserve the previous 11 examples in `docs/showcase.md` and
`docs/showcase.zh-CN.md`, with links from both READMEs and the
documentation index.
- Keep all media hosted externally; this change contains five Markdown
files.

## Type

- [ ] Fix
- [ ] Feature
- [x] Docs
- [ ] CI / tooling
- [ ] Refactor
- [ ] Other

## Verification

- [x] Relevant tests pass locally
- [x] Relevant lint / type checks pass locally
- [x] User-facing docs or screenshots are updated when needed

Commands run after rebasing onto the current target:

- `rtk proxy uv run --no-sync --all-extras pytest
tests/test_living_docs.py tests/test_docs_site.py
tests/test_docker_runtime.py
tests/test_cli_onboard_commands.py::test_readme_quickstart_matches_the_installer
-q` - 28 passed.
- `rtk proxy uv run --no-sync pre-commit run --from-ref origin/main
--to-ref HEAD` - all applicable hooks passed, including private-key
detection.
- `rtk proxy env UV_NO_SYNC=1 make check-large-files
check-source-language COMMIT_RANGE=origin/main..HEAD` - passed.
- `rtk proxy env PYTHONPATH=. uv run --no-sync python
scripts/check_commit_messages.py origin/main..HEAD` - passed.
- `rtk proxy git diff --check origin/main...HEAD` - passed.

The migrated showcase bodies match their originals byte for byte. GitHub
Markdown rendering produces three project headings, three tables, 11
images, and two video players per README, with no unrendered bold
markers. Relative links and domain terminology were checked.

All five project website links returned HTTP 200. Requests to the 19
GitHub attachment URLs returned HTTP 403 or timed out; a direct GET
retry also timed out, so media payload delivery could not be revalidated
from this environment.

Validation is scoped to documentation. Type checking is not applicable
to these Markdown-only changes. The full application and integration
suites were not run, and the showcase experiments were not rerun.

## Risk

- [x] Security impact considered
- [x] Backward compatibility considered
- [x] Rollback path is clear for risky changes

This changes the README presentation and adds navigation to the full
galleries. Runtime behavior, configuration, and dependencies are
unchanged. Media remains dependent on its external hosting. Revert this
documentation change to restore the previous layout.

## Related Issues

N/A
2026-09-26 01:18:48 +08:00