Skip to content

docs: public-readiness audit fixes (stale refs + genericize Euler mentions)#41

Merged
Marius1311 merged 1 commit into
mainfrom
docs/public-readiness-audit
Jun 30, 2026
Merged

docs: public-readiness audit fixes (stale refs + genericize Euler mentions)#41
Marius1311 merged 1 commit into
mainfrom
docs/public-readiness-audit

Conversation

@Marius1311

Copy link
Copy Markdown
Member

Prep for making the repo public. I ran three adversarial audits — secrets/privacy (working tree + full git history), README+SKILL vs the cta CLI, and reference/*.md vs code. No blockers: no credentials, no personal paths/usernames, no private data; the documented command surface, install commands, pixi envs, and layout all match the code (the test_registry_sync.py guard keeps the command list honest). This PR fixes the cosmetic findings.

Changes

  • Drop stale COSG references (COSG was removed in Simplify + align marker step: upfront gene filter in canonicalization, default-param Wilcoxon, replace COSG with filter_rank_genes_groups #36): README.md stage-3 description now reads Wilcoxon DE + filter_rank_genes_groups specificity pass; removed COSG from the marker_tools.md layout note. (marker_tools.md/differential_expression.md already framed COSG as deliberately dropped — left as-is.)
  • Fix cta_iocta.io in SKILL.md (×2) and methodology.md — there is no cta_io module; the function lives in cta/io.py.
  • Correct the detect-env "stdlib-only" claim in SKILL.md — it imports typer; reworded to "no heavy imports (no scanpy/torch)".
  • Genericize ETH-Euler-specific traces for a vendor-neutral public face: removed the Euler cluster name and module load eth_proxy from CLI help (fetch_scimilarity_model.py), pixi.toml comments, SKILL.md, and compute_environments.md, keeping the technical substance (AVX2-only CPU examples; "ensure outbound internet/proxy on a firewalled compute node").

No code-behavior changes — docs, comments, and user-facing help text only.

🤖 Generated with Claude Code

…r mentions

Prep for making the repo public. Adversarial audit of secrets/privacy, README+SKILL,
and reference docs found no blockers; these are the cosmetic fixes it surfaced.

- README: COSG (dropped in #36) -> Wilcoxon DE + filter_rank_genes_groups specificity
  pass; remove COSG from the marker_tools layout note.
- SKILL/methodology: cta_io.check_hierarchy_nesting -> cta.io.check_hierarchy_nesting
  (no cta_io module); correct the "stdlib-only" detect-env claim (it imports typer).
- Genericize ETH-Euler-specific traces for a vendor-neutral public face: drop the
  Euler cluster name and `module load eth_proxy` from CLI help / pixi.toml comments /
  reference docs, keeping the technical content (AVX2-only CPU examples, proxy guidance).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Marius1311 Marius1311 merged commit 9d712d9 into main Jun 30, 2026
0 of 2 checks passed
@Marius1311 Marius1311 deleted the docs/public-readiness-audit branch June 30, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant