Repository navigation
docs: fix guide pages that disagree with the CLI - #10
Closed
hsuchifeng wants to merge 1 commit into
Closed
hsuchifeng wants to merge 1 commit into
hsuchifeng wants to merge 1 commit into
Conversation
- init no longer pulls: getting started and the member guide now run teamai pull before doctor - manifest/projects.yaml examples gain the required version: 1 - recall: enable/disable change the local override; TEAMAI_RECALL_DISABLED only mutes hooks; the --update-quality draft name - init . layout, what push sends, role namespaces, how tags filter rules - coAuthorEnabled scope, dashboard data source, push's real message, docs.localDir default, ack body, when init records the provider
Code Erosion ReportInformational — never blocks the merge.
Scanned 319 files / 69098 SLOC · high-CC functions 516/5692 * On TypeScript, Rule hits (TS verbosity layer)Standalone
43 distinct lines flagged across |
Owner
Author
|
Generated by Claude Code |
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
Before: several guide pages described behavior the CLI no longer has. The biggest one: getting started said
initpulls, so a new member following it sawteamai doctorfail ("Skills delivered to claude ✖"). Themanifest/projects.yamlexamples also lackedversion: 1, so pasting them broke the next pull.After: every fixed statement matches the code, and the join flow (
init→pull→doctor→list) passes as written. English and zh-CN pages get the same fixes.Fixes:
initno longer pulls ([bug] init without --agent in a non-interactive shell reports agents synced but delivers nothing into the project Tencent/teamai-cli#1065): getting started and the member guide runteamai pullbeforedoctor.manifest/projects.yamlexamples (sharing, knowledge) gain the requiredversion: 1(src/projects.ts).teamai recall enable/disableset the localrecallEnabledoverride.TEAMAI_RECALL_DISABLED=1only mutes hooks, and pull still installs recall. The--update-qualitydraft is<file>.md.draft.md.init .layout (directories, notenv.yaml/mcp.yaml), whatpushsends (skills, rules, agents, env), that roles can declare env/hooks/mcp/models/docs/wiki too, and that a tag subscription filters rules instead of adding them.coAuthorEnabledlives in the scope's local config. The dashboard's Team Context has its own data source. The FAQ quotes push's real message. Thedocs.localDirdefault depends on scope. The ack body lists every field. Init records the provider only when it createsteamai.yaml.Type of Change
Test Plan
Docs only, so no e2e record is required. Each fix was checked against the source, and the main examples were run with the built CLI in an isolated HOME, against a local bare team repo through
--provider git:teamai init <url> --provider git --agent claude, thenteamai doctor: this failed "Skills delivered to claude" before the pull. Afterteamai pullit printed "All checks passed!", andteamai list skills --source reposhowed the skill.teamai push --skill ~/.claude/skills/hellofilled in the frontmatter and pushed the branch.Invalid projects manifest: version: Required. Withversion: 1it passed.tags subscribe x, then pull, printed "Synced 1 rule(s) (skipped 1 by tags)".Notes for Reviewers
Two crashes came up during testing and are left out of this PR. Each prints a raw stack trace instead of an error message:
teamai status/teamai listbeforeinit(an uncaughtNotInitializedError), andteamai packageswithout apackage.json.Generated by Claude Code