Skip to content

docs(mini_memo): use openvelaClaw brand name and add CI check - #638

Merged
tanghao-xiaomi merged 2 commits into
open-vela:dev-ai-contest-2026from
tanghao-xiaomi:docs-rename-velaclaw-and-add-check
Jul 28, 2026
Merged

docs(mini_memo): use openvelaClaw brand name and add CI check#638
tanghao-xiaomi merged 2 commits into
open-vela:dev-ai-contest-2026from
tanghao-xiaomi:docs-rename-velaclaw-and-add-check

Conversation

@tanghao-xiaomi

Copy link
Copy Markdown
Collaborator

Summary

Combines two related changes into one PR:

  1. Rename brand-styled VelaClaw -> openvelaClaw in mini_memo_guide.md (18 occurrences) to reduce trademark risk. Prefixing with the open-source project name openvela (with capital C in Claw) is a lower-risk brand form than the bare VelaClaw.
  2. Add a lightweight CI check (.github/workflows/brand-name-check.yml) that fails any PR reintroducing the CamelCase brand form VelaClaw in Markdown, so the convention is enforced going forward.

Supersedes #636 and #637.

What is NOT changed (intentional)

These are real framework API / macro names — renaming them would break examples and the actual API surface. The CI check is case-sensitive and does not flag them:

  • lowercase code identifiers: velaclaw, @system.velaclaw, velaclaw_client_open, velaclaw_ask
  • uppercase macro: VELACLAW_DAEMON

Renaming the underlying framework feature (the velaclaw API / @system. namespace) is out of scope for this PR and would require a coordinated upstream change.

CI check behavior

  • Trigger: pull_request (opened / reopened / synchronize).
  • Scans all *.md files with a plain case-sensitive grep.
  • On match: emits GitHub Actions ::error file=...,line=... annotations pointing at each offending line, prints a summary that names the allowed form and the identifiers that are intentionally exempt, and fails the job.
  • On no match: prints an OK line and passes.
  • Runtime: about 20-30 seconds on ubuntu-latest.

Commits

  1. docs(mini_memo): use openvelaClaw brand name to reduce trademark risk — the rename (24 lines changed).
  2. ci: add brand-name check for 'VelaClaw' in Markdown — the workflow (46 lines added).

The two commits are kept separate so the rename can be reviewed on its own if needed. Merging both together is the intended flow: the rename first cleans the tree, then the CI is enabled to prevent regression.

Rename the brand-styled references 'VelaClaw' to 'openvelaClaw' in the
mini_memo guide prose. The lowercase code identifiers (velaclaw_client_open,
velaclaw_ask, @system.velaclaw) and the VELACLAW_DAEMON macro are the actual
framework API and remain unchanged.
Add a lightweight PR check that fails when the CamelCase brand form
'VelaClaw' appears in any Markdown file. The convention is to use
'openvelaClaw' (lowercase 'openvela' prefix, capital 'C') as the brand
name in prose, to reduce trademark risk.

The check is intentionally case-sensitive and does NOT flag:
  - lowercase code identifiers: velaclaw, @system.velaclaw,
    velaclaw_client_open, velaclaw_ask (real framework APIs)
  - uppercase macro: VELACLAW_DAEMON (real Kconfig / macro name)

Note: this check depends on the brand rename in open-vela#636 being merged
first. Otherwise the base branch's existing 'VelaClaw' occurrences
would cause subsequent PRs to fail.
@tanghao-xiaomi
tanghao-xiaomi requested review from a team as code owners July 28, 2026 12:07
@tanghao-xiaomi
tanghao-xiaomi merged commit e0fe84e into open-vela:dev-ai-contest-2026 Jul 28, 2026
5 checks passed
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