From 1e170411aca1971de8491becf7cd2f5d588eef15 Mon Sep 17 00:00:00 2001 From: Tim Walsh Date: Thu, 16 Jul 2026 19:42:21 -0700 Subject: [PATCH] docs: refresh site and README for post-v0.1.0 accuracy - Drop stale "Available with the first tagged release" Homebrew phrasing now that v0.1.0 shipped (README, site homepage) - Clarify npm status: @timimsms/cu is a reserved placeholder only, no functional package published, no install command advertised - Note the go-install "dev" version caveat with a link to #36 - Cross-reference planned env-token fallback (#26) on the auth page - Enable content.action.edit so the configured edit_uri actually renders - Narrow deploy-docs path trigger to docs/site/** (design docs no longer trigger Pages deploys) - Pin mkdocs-material to 9.x in deploy and CI workflows Co-Authored-By: Claude Fable 5 --- .github/workflows/ci.yml | 2 +- .github/workflows/deploy-docs.yml | 4 ++-- README.md | 6 ++++-- docs/site/authentication.md | 2 +- docs/site/index.md | 6 ++++-- mkdocs.yml | 1 + 6 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c029ecc..a4978b1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -130,7 +130,7 @@ jobs: - name: Install MkDocs and theme run: | - pip install mkdocs-material + pip install 'mkdocs-material==9.*' - name: Test documentation build run: mkdocs build --strict --site-dir _test_site \ No newline at end of file diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 5dcf282..8bcfdd6 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -5,7 +5,7 @@ on: branches: - main paths: - - 'docs/**' + - 'docs/site/**' - 'mkdocs.yml' - '.github/workflows/deploy-docs.yml' workflow_dispatch: @@ -33,7 +33,7 @@ jobs: - name: Install MkDocs and theme run: | - pip install mkdocs-material + pip install 'mkdocs-material==9.*' - name: Build documentation run: mkdocs build --strict --site-dir _site diff --git a/README.md b/README.md index d5e0908..6ca1d1e 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,17 @@ A GitHub CLI-inspired command-line interface for ClickUp. brew install timimsms/cu/cu ``` -Installs from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap. Available with the first tagged release. +Installs the latest tagged release from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap. ### Go ```bash go install github.com/timimsms/cu/cmd/cu@latest ``` +Note: binaries installed via `go install` currently report `dev` from `cu version` ([#36](https://github.com/timimsms/cu/issues/36)); Homebrew and release downloads embed the real version. + ### npm -Planned as `@timimsms/cu` (not yet published). +The package name `@timimsms/cu` is reserved on npm as a placeholder only — a functional package is not yet published. Use Homebrew, `go install`, or a release download instead. ### Direct Download Download the latest release from the [releases page](https://github.com/timimsms/cu/releases). diff --git a/docs/site/authentication.md b/docs/site/authentication.md index feea070..579171c 100644 --- a/docs/site/authentication.md +++ b/docs/site/authentication.md @@ -36,7 +36,7 @@ Tokens are never written to disk in plaintext by `cu` — there is no plaintext ## Headless Linux Caveat -On headless Linux (servers, containers, CI), `cu` requires a running Secret Service implementation to store and read the token. There is currently no environment-variable fallback, so authentication will fail without one. A common workaround is to run a keyring daemon such as `gnome-keyring-daemon` with a D-Bus session. +On headless Linux (servers, containers, CI), `cu` requires a running Secret Service implementation to store and read the token. There is currently no environment-variable fallback, so authentication will fail without one. A common workaround is to run a keyring daemon such as `gnome-keyring-daemon` with a D-Bus session. An environment-variable token fallback is planned — see [issue #26](https://github.com/timimsms/cu/issues/26). ## Revoking Access diff --git a/docs/site/index.md b/docs/site/index.md index 0d125f4..c876de5 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -29,7 +29,7 @@ A GitHub CLI-inspired command-line interface for ClickUp. brew install timimsms/cu/cu ``` -Installs from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap. Available with the first tagged release. +Installs the latest tagged release from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap. ### Go @@ -37,9 +37,11 @@ Installs from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu go install github.com/timimsms/cu/cmd/cu@latest ``` +Note: binaries installed via `go install` currently report `dev` from `cu version` ([#36](https://github.com/timimsms/cu/issues/36)); Homebrew and release downloads embed the real version. + ### npm -Planned as `@timimsms/cu` (not yet published). +The package name `@timimsms/cu` is reserved on npm as a placeholder only — a functional package is not yet published. Use Homebrew, `go install`, or a release download instead. ### Direct Download diff --git a/mkdocs.yml b/mkdocs.yml index b3cf496..fed4b96 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,7 @@ theme: - search.highlight - content.tabs.link - content.code.copy + - content.action.edit nav: - Home: index.md