@icebreakers/monorepo-templates 1.0.15 → 1.2.0

package/templates/vitepress/en/repoctl/troubleshooting.md

@@ -1,96 +0,0 @@
-# Troubleshooting
-
-repoctl focuses on reports that can be reproduced, saved, and shared.
-
-## Start With Doctor
-
-```bash
-repo doctor
-repo doctor --strict
-```
-
-`doctor` checks:
-
-- Current directory and repository root.
-- Node.js version.
-- `pnpm-workspace.yaml`.
-- The `repoctl` CLI dependency.
-- Recommended root scripts.
-- Conflicting config files.
-- Husky and lint-staged wiring.
-
-## Save A Diagnostic Report
-
-```bash
-repo doctor --json --out reports/doctor.json
-repo doctor --markdown --redact --out reports/doctor.md
-```
-
-Markdown reports are useful in issues and PRs. `--redact` removes local absolute paths.
-
-## Inspect The Verification Plan
-
-```bash
-repo check --dry-run
-repo check --json --out reports/check-plan.json
-repo check --markdown --redact --out reports/check-plan.md
-```
-
-Use this when you need to understand why a file triggers a workspace typecheck or which tasks pre-push would run.
-
-## Collect Environment Information
-
-```bash
-repo env info
-repo env support --markdown --redact --out reports/support.md
-repo env snapshot --json --out reports/snapshot.json
-repo env paths --markdown --redact --out reports/paths.md
-```
-
-These commands help compare local, CI, Git, Node, pnpm, and workspace differences.
-
-## Common Fixes
-
-### Not At Repository Root
-
-Change into the directory that contains `pnpm-workspace.yaml` and the root `package.json`, then run:
-
-```bash
-repo doctor
-```
-
-### Conflicting Config Files
-
-Keep only:
-
-```txt
-repoctl.config.ts
-```
-
-`monorepo.config.ts` is no longer loaded at runtime; rename it to `repoctl.config.ts`.
-
-### Unknown Template Key
-
-List available templates:
-
-```bash
-repo templates
-```
-
-Explicit `--template` values are validated first. Invalid keys fail with suggestions.
-
-### Automation Should Not Prompt
-
-Use non-interactive options:
-
-```bash
-repo init --yes
-repo upgrade --no-overwrite
-repo check --json --out reports/check-plan.json
-```
-
-## Keep Reading
-
-- [Workflows and CI](./workflows.md)
-- [Command Reference](./commands.md)
-- [Command Aliases](./aliases.md)

package/templates/vitepress/en/repoctl/workflows.md

@@ -1,89 +0,0 @@
-# Workflows and CI
-
-repoctl commands have two audiences: humans using short daily commands, and automation consuming stable reports.
-
-## Local Daily Workflow
-
-```bash
-pnpm install
-pnpm run repo:doctor
-pnpm run repo:new -- sdk --template tsdown
-pnpm run repo:check
-pnpm build
-```
-
-| Step                   | What It Proves                                          |
-| ---------------------- | ------------------------------------------------------- |
-| `pnpm install`         | Workspace dependencies and local links are ready        |
-| `pnpm run repo:doctor` | Root files, Node, scripts, config, and hooks are usable |
-| `pnpm run repo:new`    | New packages follow template conventions                |
-| `pnpm run repo:check`  | The lightweight local verification flow is reproducible |
-| `pnpm build`           | The workspace build graph has no obvious breakage       |
-
-## Adopt An Existing Repository
-
-```bash
-pnpm add -D repoctl
-pnpm exec repo init --yes
-pnpm exec repo doctor --markdown --out reports/doctor.md
-pnpm exec repo upgrade --no-overwrite
-pnpm exec repo doctor
-```
-
-Start conservatively with `--no-overwrite`. After reviewing asset drift, decide whether `--yes` or `--overwrite` is appropriate.
-
-## Fast CI Gate
-
-```bash
-pnpm install --frozen-lockfile
-pnpm exec repo doctor --strict
-pnpm exec repo check --full
-```
-
-This is a simple gate for small repositories or early projects. `doctor --strict` treats warnings as failures.
-
-## CI Report Mode
-
-```bash
-pnpm exec repo doctor --json --out reports/doctor.json
-pnpm exec repo check --json --out reports/check-plan.json
-pnpm exec repo env support --markdown --redact --out reports/support.md
-```
-
-Use these outputs as CI artifacts:
-
-- `doctor.json` for scripts.
-- `check-plan.json` to explain verification routing.
-- `support.md` for issues, PRs, and external collaboration.
-
-## Hooks
-
-```bash
-repo verify pre-commit
-repo verify staged-typecheck packages/app/src/main.ts
-repo verify commit-msg .git/COMMIT_EDITMSG
-repo verify pre-push
-```
-
-| Stage      | Recommended Behavior                                      |
-| ---------- | --------------------------------------------------------- |
-| pre-commit | Focus on staged files, lint, and workspace typecheck      |
-| commit-msg | Enforce Conventional Commit messages                      |
-| pre-push   | Run root lint/typecheck and affected build/test/tsd tasks |
-
-## Non-Interactive Options
-
-| Scenario                              | Option                                             |
-| ------------------------------------- | -------------------------------------------------- |
-| Accept setup defaults                 | `repo init --yes`                                  |
-| Preserve changed files during upgrade | `repo upgrade --no-overwrite`                      |
-| Explicitly overwrite standard assets  | `repo upgrade --yes` or `repo upgrade --overwrite` |
-| Preview only                          | `--dry-run`                                        |
-| Output for scripts                    | `--json --out <file>`                              |
-| Share a redacted report               | `--markdown --redact --out <file>`                 |
-
-## Keep Reading
-
-- [Command Reference](./commands.md)
-- [Troubleshooting](./troubleshooting.md)
-- [Command Aliases](./aliases.md)