docs(contest_2026): add AI Coding log guide (markdown) and cross-link it - #593
Merged
tanghao-xiaomi merged 2 commits intoJun 15, 2026
Conversation
- Add ai_coding_log_guide.md (formal tutorial converted from Feishu): install, enable AI tools, export/submit logs, privacy, troubleshooting - Repoint AI-log references from .claude/USAGE.md to the in-repo guide in contest_overview, code_submission_guide, quickapp_manual, ai_hardware_track_guide - List the new guide in the three track index pages - code_submission_guide: repo naming rule contest2026-<编号>-<队伍名> (one repo/team)
…d steps Match the AI Coding log guide style (numbered ①-⑤ steps with section refs)
tanghao-xiaomi
merged commit Jun 15, 2026
cbd1b89
into
open-vela:dev-ai-contest-2026
2 of 4 checks passed
yanxingyu17
added a commit
to yanxingyu17/docs
that referenced
this pull request
Jun 16, 2026
…pen-vela#24) The guide was added in PR open-vela#593 from a snapshot that pre-dated two relevant tool changes in open-vela/.claude: - PR open-vela#24 (zero-touch install): install.sh no longer copies tools into the demo repo. Tools live in the sibling .claude/ tools repo and contestants invoke them via relative path. The demo repo only receives logs/<github_login>/... after explicit --confirm export. - PR open-vela#25 (--since tz fix): naive --since dates on Python 3.11+ no longer crash. No command-line surface change. This commit syncs the guide to the post-PR-open-vela#24 reality: 1. Every 'python3 tools/...' is rewritten to 'python3 ../.claude/skills/contest-log-collector/tools/...', matching what install.sh now tells contestants to run. 2. The 'file layout' appendix is rewritten: - demo repo only shows logs/ as a post-export-only directory - removed the misleading line that claimed install.sh would generate .claude/.opencode/tools/schema/ inside the demo repo (this is no longer true after PR open-vela#24) - new top paragraph states the zero-touch property explicitly - ~/.config/opencode/plugin/contest-collector.js added (new location in PR open-vela#24) 3. Two prose references to 'tools/export-session.py' and 'tools/validate-log.py' (in the natural-language trigger paragraph and in the Q3 anti-cheat description) get the same '../.claude/skills/...' prefix so the contestant can copy-paste. No functional / privacy / behavioural claim changed - all the two-stage staging + --confirm semantics, redaction rules, FAQ answers, and field tables remain as written. Tested by running each updated command on a fresh manifest mock (open-vela/contest2026_000_openvela#2 was the e2e proof of the zero-touch flow). Signed-off-by: v-yanxingyu <v-yanxingyu@xiaomi.com>
tanghao-xiaomi
pushed a commit
that referenced
this pull request
Jun 16, 2026
…apshot shortcut The guide was added in #593 from a snapshot that pre-dated two tool changes in open-vela/.claude: - PR #24 (zero-touch install, merged): install.sh no longer copies tools into the demo repo. Tools live in the sibling .claude/ tools repo. Demo repo only receives logs/<github_login>/... after explicit --confirm export. - PR #26 (contest-snapshot shortcut, in flight): install.sh additionally installs ~/.local/bin/contest-snapshot, a thin wrapper that resolves the sibling .claude/ via git toplevel and execs the real export-session.py. Forwards all args. This commit syncs the guide accordingly. Three substantive edits: 1. Every contestant-facing export command is rewritten from the long form python3 tools/export-session.py --latest --confirm to the short form contest-snapshot --latest --confirm This covers section 3 (the three trigger methods), section 5 (verify steps), and Q5 (final-hour playbook). 16 sites total. 2. New paragraph at the bottom of section 3.3 explains what to do when 'contest-snapshot: command not found' (~/.local/bin not on PATH). Two options: append PATH in ~/.bashrc, or fall back to the full python3 ../.claude/skills/... invocation. 3. Judge tools (render-log.py / validate-log.py) have no shortcut and stay on the full python3 ../.claude/skills/contest-log-collector/tools/... path, since they are run by judges and reviewers, not by the contestant in their daily loop. Appendix file-tree: - removed the misleading line claiming install.sh generates .claude/.opencode/tools/schema/ inside the demo repo (no longer true after PR #24) - added the new ~/.local/bin/contest-snapshot entry under the home-directory install footprint - added ~/.config/opencode/plugin/contest-collector.js, which is where PR #24 moved the OpenCode plugin No functional / privacy / behavioural claim changed. All two-stage staging + --confirm semantics, redaction rules, FAQ answers, and field tables remain as written. Tested by running each updated command on a fresh manifest mock: contest-snapshot --list -> ok contest-snapshot --latest -> preview contest-snapshot --latest --confirm -> writes logs/... verify-setup.sh -> Passed 11 Failed 0 End-to-end proof that the demo repo stays clean: open-vela/contest2026_000_openvela#2 (2 files, 22 lines). Signed-off-by: v-yanxingyu <v-yanxingyu@xiaomi.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note: Please adhere to Contributing Guidelines.
Summary
Update this section with information on why change is necessary,
what it exactly does and how, if new feature shows up, provide
references (dependencies, similar problems and solutions), etc.
Impact
Update this section, where applicable, on how change affects users,
build process, hardware, documentation, security, compatibility, etc.
Testing
Update this section with details on how did you verify the change,
what Host was used for build (OS, CPU, compiler, ..), what Target was
used for verification (arch, board:config, ..), etc. Providing build
and runtime logs from before and after change is highly appreciated.