docs: align config and github workflow#314
Open
cyfyifanchen wants to merge 6 commits into
Open
Conversation
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
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.
Summary
README.md,README.zh-CN.md, anduse-cases/README.mdunchanged in this PR.everos initandeveros server startflow.session_lock_timeout_secondsinto the[memorize]section of the shipped default TOML so generated configs match the settings model.CLAUDE.mdand Claude slash-command skills to use the GitHubmainbranch workflow instead of the old internal branch model.scripts/check_github_contributor_docs.pyand wire it intomake lint/make docs-checkso contributor-facing docs cannot regress to the old branch/review wording.docs/github-sync.mdto record the GitLab-to-GitHub sync guard: preserve GitHub-only contributor, workflow, template, and Claude skill files during future exports/overwrites.Why
The codebase is already TOML-first and requires provider
base_urlvalues at runtime, but some non-README docs still described outdated config behavior or stale package metadata.Separately, contributor guidance copied from the internal workflow still referenced non-existent public branches and review terminology. That does not affect normal users, but it can mislead community contributors and automated Claude Code skills.
This PR also records the future sync rule explicitly: when refreshing GitHub from GitLab/internal exports, do not overwrite the GitHub-only contributor docs, workflows, templates, or Claude skills that encode the public
mainbranch workflow.Validation
make docs-checkmake lintuv run python scripts/check_pr_title.py "docs: align config and github workflow"uv run python scripts/check_docs.pyuv run python scripts/check_repo_assets.pyuv run python scripts/check_deprecated_names.pyuv run python scripts/check_github_contributor_docs.pyuv run pytest tests/unit/test_config/test_settings.py tests/unit/test_entrypoints/test_cli/test_init_command.py -quv run pytest tests/unit/test_component/test_llm/test_client.py tests/unit/test_component/test_llm/test_factory.py tests/unit/test_component/test_embedding/test_factory.py tests/unit/test_component/test_rerank/test_factory.py -quv run pytest tests/unit/test_scripts/test_check_github_contributor_docs.py tests/unit/test_scripts/test_check_deprecated_names.py -quv run ruff check scripts/check_github_contributor_docs.py tests/unit/test_scripts/test_check_github_contributor_docs.pyuv run ruff format --check scripts/check_github_contributor_docs.py tests/unit/test_scripts/test_check_github_contributor_docs.pyuv run ruff check src testsuv run python scripts/dump_openapi.py --checkuv run python scripts/check_datetime_discipline.pyuv run ruff format --check src testsuv run lint-imports