From 94ce0758bec2ef4a5fda192f9dc1a8d91ff14182 Mon Sep 17 00:00:00 2001 From: Florian Dieminger Date: Tue, 17 Dec 2024 16:32:36 +0100 Subject: [PATCH] update tool doc --- docs/cli-tool.md | 48 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/docs/cli-tool.md b/docs/cli-tool.md index de6e51476584..133a04cc7515 100644 --- a/docs/cli-tool.md +++ b/docs/cli-tool.md @@ -8,16 +8,13 @@ Run the CLI tool: yarn tool --help ``` -## Commands - -### validate-redirect - -Validates the content of the `_redirects.txt` files(s). (This does not verify -that _to URLs_ exist) +### Or run the legacy version -### test-redirect +```sh +yarn tool:legacy --help +``` -Test whether an URL path is a redirect and display the according target. +## Commands ### add-redirect @@ -34,25 +31,50 @@ redirects). Move a document and its children. Adds the according redirects and stages changes in `git` (except for redirects). -### edit +### sync-translated-content + +Syncs translated content for all or a list of locales. + +### fmt-sidebars + +Formats all sidebars in content. + +### sync-sidebars + +Sync sidebars with redirects in content. + +### fix-redirects + +Fixes redirects across all locales. + +### validate-redirect (only in legacy) + +Validates the content of the `_redirects.txt` files(s). (This does not verify +that _to URLs_ exist) + +### test-redirect (only in legacy) + +Test whether an URL path is a redirect and display the according target. + +### edit (only in legacy) Open a document by its slug in the preferred editor (as per the `EDITOR` environment variable). -### create +### create (only in legacy) Open a _new_ document by its slug in the preferred editor (as per the `EDITOR` environment variable). -### validate +### validate (only in legacy) Run basic validation for a document (only verifies the slug for now). -### preview +### preview (only in legacy) Open a preview of a given slug in your browser. This depends on a running dev-server (`yarn start`). -### flaws +### flaws (only in legacy) Show and optionally fix fixable flaws for a given slug.