eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions

Add doc consistency checks and update pypi proxy docs

Browse source 
Add orphan detection to doc-links, and three new doc tasks: doc-index
(category index coverage), doc-stale (staleness report), doc-tags (tag
inventory). Register doc-index as a pre-commit hook. Update
use-pypi-proxy to document env-var-based proxy toggle.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Erich Blume 2026-02-05 15:57:24 -08:00
commit a3dec7f6e2
9 changed files with 356 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/changelog.d/doc-exploring-the-docs-review.doc.md
View file

@ -1 +1 @@
Review and clean up exploring-the-docs tutorial: simplify wiki-links, fix broken replication/ reference, add Related section, match zk-docs flags to CLAUDE.md.
Review and clean up exploring-the-docs tutorial: simplify wiki-links, fix broken replication/ reference, add Related section, match zk-docs flags to CLAUDE.md. Add documentation consistency checks: orphan detection in doc-links, new doc-index (category index coverage), doc-stale (staleness report), and doc-tags (tag inventory). Update use-pypi-proxy to document env-var-based proxy toggle.

19
docs/how-to/use-pypi-proxy.md
View file

@ -9,21 +9,20 @@ tags:
How to configure clients and publish packages to [[devpi]].
## Configure pip
## Configure pip/uv
Create `~/.config/pip/pip.conf`:
Point pip and uv at the proxy via environment variables:
```ini
[global]
index-url = https://pypi.ops.eblu.me/root/pypi/+simple/
trusted-host = pypi.ops.eblu.me
```
Track with chezmoi:
```bash
chezmoi add ~/.config/pip/pip.conf
export PIP_INDEX_URL="https://pypi.ops.eblu.me/root/pypi/+simple/"
export UV_INDEX_URL="https://pypi.ops.eblu.me/root/pypi/+simple/"
```
Unset both to fall back to public PyPI (e.g. when [[indri]] is offline).
The [dotfiles repo](https://github.com/eblume/dotfiles) has shell config
that manages this toggle.
## Upload Packages
```bash

5
docs/tutorials/ai-assistance-guide.md
View file

@ -94,9 +94,12 @@ BlumeOps operations are driven by mise tasks. Run `mise tasks` to list all avail
| `dns-up` | Apply DNS changes via Pulumi |
| `tailnet-preview` | Preview Tailscale ACL changes |
| `tailnet-up` | Apply Tailscale ACL changes via Pulumi |
| `doc-links` | Validate wiki-links in documentation |
| `doc-links` | Validate wiki-links in documentation (includes orphan detection) |
| `doc-index` | Check every doc is referenced in its category index |
| `doc-titles` | Check for duplicate doc titles |
| `doc-filenames` | Check for duplicate doc filenames |
| `doc-stale` | Report docs by last-modified date, highlight stale ones |
| `doc-tags` | Print frontmatter tag inventory across all docs |
| `doc-random` | Select a random doc card for review |
| `indri-runner-logs` | View Forgejo workflow logs from local runner |