Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR resets the repository’s documentation surface to a smaller set of current root-level docs, removing historical/stale planning documents and experiment notes, and updates local developer ergonomics via Make targets. It also refreshes uv.lock to reflect the current project version.
Changes:
- Rewrite/condense the active docs (
README.md,CONTRIBUTING.md,AGENTS.md,CLAUDE.md) and delete stale documentation trees/files underdocs/andexperiments/. - Add Makefile convenience targets for common local runs (
run,sync-diff,web,web-admin). - Bump the editable package version in
uv.lockto match the repo version.
Reviewed changes
Copilot reviewed 17 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| uv.lock | Updates the editable kardscm package entry version to 0.9.0. |
| README.md | Rewrites user-facing documentation into a leaner, task-oriented guide. |
| Makefile | Adds new convenience targets (run, sync-diff, web, web-admin) and updates .PHONY. |
| experiments/README.md | Removes the experiments documentation (stale / not part of active doc surface). |
| docs/superpowers/specs/2026-05-01-video-first-llm-deck-testing.md | Removes historical/private experiment spec. |
| docs/superpowers/specs/2026-04-29-locale-files-design.md | Removes historical design spec no longer kept as active docs. |
| docs/superpowers/specs/2026-04-25-nerf-buff-design.md | Removes historical design spec. |
| docs/superpowers/specs/2026-04-23-rules-sync-skill-design.md | Removes historical design spec. |
| docs/superpowers/specs/2026-04-23-mvp-release-polish-design.md | Removes historical design spec. |
| docs/superpowers/specs/2026-04-23-kardscm-roadmap.md | Removes historical roadmap document. |
| docs/superpowers/SESSION_START.md | Removes session bootstrap doc in favor of root-level policy docs. |
| docs/superpowers/plans/2026-04-29-locale-extraction.md | Removes historical implementation plan. |
| docs/superpowers/plans/2026-04-24-execution-plan.md | Removes historical execution plan. |
| docs/api/graphql-schema.md | Removes stale API schema notes that no longer reflect reality. |
| CONTRIBUTING.md | Expands/refreshes contributor and maintainer documentation, including architecture and release process. |
| CLAUDE.md | Slims Claude-specific notes to pointers and tracked local assets. |
| AGENTS.md | Rewrites agent operating rules into a shorter, current set aligned with the new doc policy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
46
to
+75
| ```bash | ||
| git clone git@github.com:AABur/kardscm.git | ||
| cd kardscm | ||
| make sync | ||
| ``` | ||
|
|
||
| Or, for an isolated install without cloning: | ||
| For an isolated command install: | ||
|
|
||
| ```bash | ||
| pipx install git+https://github.com/AABur/kardscm.git | ||
| ``` | ||
|
|
||
| ## Configuration | ||
| ## Quick Start | ||
|
|
||
| Pick a UI language with the global `--lang` flag — it works on every | ||
| subcommand (default is English): | ||
| ```bash | ||
| # 1. Sync the card catalog into collection.db. | ||
| kardscm sync | ||
|
|
||
| # 2. Open the local browser UI and edit quantities. | ||
| kardscm web | ||
|
|
||
| # 3. Export your collection. | ||
| kardscm export -f xlsx -o cards.xlsx | ||
|
|
||
| # 4. Add a deck exported from the KARDS client. | ||
| kardscm deck add my-deck.txt | ||
|
|
||
| # 5. Export a saved deck. | ||
| kardscm deck export -f xlsx -o deck.xlsx | ||
| ``` |
Comment on lines
+227
to
+228
| kardscm baseline init | ||
| kardscm baseline accept |
AABur
added a commit
that referenced
this pull request
May 9, 2026
Without an activated virtualenv, the kardscm console script is not on PATH for clone-based installs (per Copilot review on PR #34). Use uv run kardscm in the Quick Start and API Baseline blocks; pipx users can drop the prefix.
Without an activated virtualenv, the kardscm console script is not on PATH for clone-based installs (per Copilot review on PR #34). Use uv run kardscm in the Quick Start and API Baseline blocks; pipx users can drop the prefix.
AABur
force-pushed
the
docs/project-docs-reset
branch
from
95afea3 to
7aa41c4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Net effect: 17 files touched, ~544 insertions / ~4328 deletions. The repo's doc surface now lives in four root-level files plus `CHANGELOG.md`, per the project policy in `AGENTS.md`.
Test plan