Skip to content

History / Contributing to the Wiki

Revisions

  • wiki: adopt GitHub Alerts for callouts across the wiki Convert advisory blockquotes and inline callouts to semantic GitHub Alerts (NOTE/TIP/IMPORTANT/CAUTION): - [!NOTE] for the standard category-page "workflow layer" ledes and other top-of-page orientation / "canonical reference" notes - [!IMPORTANT] for behavior-affecting gotchas (auto approx-stats on OOM, group-by unsupported aggs, MiniJinja filter-errors-as-values, synthesize cross-column correlation, profile always-warn RFC4180) - [!TIP] for the Binary-Variants TL;DR and Why-qsv "why it matters" - [!CAUTION] for foreach shell-injection risk and joinp --cross blowup Also update the Contributing-to-the-Wiki category template to use the [!NOTE] lede so new pages follow the convention. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

    @jqnatividad jqnatividad committed May 30, 2026
  • wiki: add lint script + example CI workflow scripts/lint.sh runs two checks against the wiki: 1. Every `qsv <command>` reference in a code context (fenced block or inline backtick) is a real command per `qsv --list`. The script merges `qsv --list` with a known feature-gated set (clipboard, prompt, py, lens, color, etc.) so a lite-build qsv still validates the full wiki. 2. When QSV_REPO_PATH points at a checkout of dathere/qsv, every `/docs/help/<X>.md` reference resolves to a real file in that checkout's docs/help/ directory. Exit codes: 0=clean, 1=stale references, 2=setup error. Allowlist files under scripts/lint.allowlist (per-token) and a built-in HELP_ALLOWLIST for template placeholders (cmd1, cmd2, X, etc.). scripts/wiki-lint-workflow.yml is a ready-to-copy GitHub Actions workflow for the MAIN qsv repo. GitHub Actions doesn't run on *.wiki repos, so the workflow file must live there. It runs nightly + on PRs that touch src/cmd/, src/main.rs, or docs/help/, and opens a sticky `wiki-lint` issue on scheduled failure. Also fixes the only real bug the lint caught: Command-Reference linked to a non-existent /docs/help/help.md. Reworded the row to describe `qsv help` without a broken link. Contributing-to-the-Wiki gets a new "Linting" section documenting both the local run and the CI setup. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @jqnatividad jqnatividad committed May 13, 2026
  • wiki: Phase E complete - all 6 polish pages Troubleshooting: organized by category - install/launch (SIGILL, macOS Gatekeeper, Windows PATH, musl Luau), encoding/format (UTF-8, wrong delimiter, ragged rows, BOM), index/cache (stale, missing JSONL, Polars schema drift), memory (OOM, ext-* alternatives, approx algorithms), specific commands (stats date-whitelist, search case sensitivity, fetch rate limits, excel edge cases). Plus diagnostics with --version, --envlist, QSV_LOG_LEVEL, and where to report bugs. FAQ: short answers to the most-asked questions. qsv vs pandas/DuckDB/csvkit/ miller/xsv, Windows/ARM/IBM platform support, streaming vs in-memory, what an index/stats-cache/automagical command is, how to update, what features my qsv has, AI/LLM privacy (no data leaves your machine unless you explicitly send it), bug-reporting flow. Comparison: head-to-head with xsv (qsvlite is the drop-in), csvkit (10x faster), Miller (overlap, both excellent), DuckDB (complement, not replace - to-parquet hand-off), pandas (qsv as the preprocessing layer), Visidata (qsv lens is the closest equivalent), awk/sed (qsv understands CSV quoting). Ends with a "which tool when" cheat sheet. Glossary: 30+ terms - antimode, asof join, automagical, BLAKE3, cardinality, CKAN, DataSketches, dyncols, lazy frame, lookup table, MAD, MCP, MiniJinja, neuro-symbolic, non-equi join, Polars, Polars schema, Pragmastat, pseudonymization, reservoir sampling, RFC 4180, sortiness, stats cache, streaming, TOON, t-digest, WKT, XSD. External-Resources: try-it-online, 100.dathere.com lessons, 5 conference talks, "Have we achieved ACI?" 3-part blog series, canonical /docs/ links, live benchmark dashboard, Discussions categories, datHere ecosystem (qsv pro, qsv-recipes, qsv-lookup-tables, qsv-cookiecutter, DataPusher+), 4 contributed notebooks, packaging across 10 distros, underlying library credits, Zenodo DOI + DeepWiki + FOSSA, sponsor link. Contributing-to-the-Wiki: clone+commit+push workflow, page conventions (H1, tier badge, See also), templates for command-reference and recipe pages, when-to-update matrix, 10-item verification checklist, commit- message convention, don't-duplicate-/docs/ guidance, anchor dataset conventions, slug rules, asset handling, asciinema casts. All 49 wiki pages now have substantive content. Plan complete. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @jqnatividad jqnatividad committed May 13, 2026
  • wiki: add stubs for Phase B/C/D/E pages so sidebar links resolve Adds 39 placeholder pages so every sidebar entry resolves to real content rather than a 404. Each stub declares its tier, the phase it will be filled in, and a one-paragraph preview of what's coming. They link back to Home / Getting-Started / Command-Reference / Cookbook for navigation. Pages added: - Phase B (Command Reference, 13): Command-Reference, Selection-and- Inspection, Transform-and-Reshape, Aggregation-and-Statistics, Joins- and-Set-Ops, SQL-and-Polars, Validation-and-Schema, Conversion-and-IO, Geospatial, HTTP-and-Web, Scripting-Luau-Python, Indexing-Compression- Diff, AI-and-Documentation - Phase C (Cookbook recipes, 12): Recipe-Inspect-Unknown-CSV, Recipe- Clean-and-Normalize, Recipe-Geographic-Enrichment, Recipe-Date- Enrichment, Recipe-CKAN-Integration, Recipe-JSON-Schema-Validate, Recipe-Build-a-Data-Pipeline, Recipe-Stats-to-Insights, Recipe-Fetch- and-Cache, Recipe-Larger-than-RAM, Recipe-Diff-and-Audit, Recipe-Multi- Table-Joins - Phase D (Tuning + ecosystem, 8): Performance-Tuning, Environment- Variables, Stats-Cache-and-Caching, Lookup-Tables, Claude-Cowork-Plugin, MCP-Server, qsv-pro-Spotlight, Integrations - Phase E (Polish, 6): Troubleshooting, FAQ, Comparison, Glossary, External-Resources, Contributing-to-the-Wiki Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @jqnatividad jqnatividad committed May 13, 2026