docs: de-stale README/CHANGELOG/release docs, add cleanroom + heap notes, drop expired shims#197
Merged
Merged
Conversation
…tes, drop expired shims Documentation accuracy sweep plus one code cleanup, aligned to the 0.7.0 cli / 0.8.0 root release (PR #190) and the single-published-package reality (PR #189). README: - Correct Status from the stale 0.1.1 tag to the real cli 0.7.0 / root 0.8.0 versions. - Point the docs link at the live Astro Starlight site (theagenticguy.github.io/opencodehub, source in packages/docs/), not a 'being bootstrapped' repo. - Scope the 'zero native builds' claim to grammar/WASM parsing; add a Platform support section noting storage/embeddings load prebuilt native bindings on a 5-target matrix (darwin/linux x64+arm64, win32-x64) and hard-fail on win32-arm64 / musl. - Reconcile the Node floor to 22/24 (the CI-tested + root-required set) and align packages/cli and packages/ingestion engines (>=20 -> >=22) with the root engines field; the rest already said >=22. - Add a Troubleshooting note for analyze OOM on large repos with the NODE_OPTIONS=--max-old-space-size escape hatch (KnowledgeGraph is two in-memory Maps with no spill). ADRs: - Add ADR 0018 documenting that route_map/tool_map/shape_check/ api_impact/group_list/group_sync are independently derived from observable behavior and generic vocabulary (no rename). - ADR 0012: mark the M7 Repo-rooted edge kinds (T-M7-6/T-M7-7) as not-pursued (v1 clean-slate); none shipped, and OWNED_BY is a blame-level edge, not the repo-level one sketched. - ADR 0013-m7: correct the false 'now 28' edge-cardinality claim to the true edges.ts count of 25. Release/changelog: - release.yml + RELEASE.md: reframe npm publish as single-package (@opencodehub/cli only; others private/bundled) and OIDC trusted publishing as live (run #176 shipped 0.6.0 with provenance), not pending; fix RELEASE.md's stale detect-secrets gate refs to betterleaks (ADR 0017). - smoke-mcp.sh: fix EXPECTED_TOOLS default 29 -> 28 (functional defect) and correct the roster comment (drop removed rename/remove_dead_code, add signature). - CHANGELOG.md: remove the orphaned hand-written [Unreleased] block with stale 29-tool / 17-package claims (release-please owns this file and never emits [Unreleased]). Code cleanup (post-#189, every library package is private, no external consumers): - Drop the dead @opencodehub/analysis wiki re-export shim (generateWiki + Wiki* types) and the LSP_PROVENANCE_PREFIXES alias (+ its core-types barrel re-export). Verified zero in-repo importers. Validation: build (all non-docs packages) green; tests green (core-types 83, analysis 128, storage 161, ingestion 562, cli 286 pass / 16 skip / 0 fail); biome clean; banned-strings PASS.
The symbol was deleted in this PR; its only remaining mention was this README API list. ADR 0005's historical 'SCIP replaces LSP' reference is left intact.
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
1 participant
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.
What changed
Documentation accuracy sweep aligned to the 0.7.0 cli / 0.8.0 root release (#190) and the single-published-package reality (#189), plus one dead-code cleanup.
README
0.1.1to@opencodehub/cli0.7.0 / root 0.8.0.https://theagenticguy.github.io/opencodehub, sourcepackages/docs/), replacing the false "being bootstrapped" claim.@ladybugdb/core,@duckdb/node-api,onnxruntime-nodeare prebuilt native). Reworded so "zero grammar/native builds" is scoped to WASM parsing; added a Platform support section (5-target prebuilt matrix; win32-arm64 / musl hard-fail viaGraphDbBindingError, no fallback per ADR 0016).analyzeOOM (KnowledgeGraph is two in-memory Maps, no spill) with theNODE_OPTIONS=--max-old-space-sizeescape hatch.Node floor reconciliation
Was stated four contradictory ways. Decision: standardize on 22/24 — CI matrix is
[22,24], root already required>=22, nothing tests Node 20. Alignedpackages/cliandpackages/ingestionengines>=20 → >=22.ADRs
route_map/tool_map/shape_check/api_impact/group_list/group_syncas independently derived (no renames).Repo-rooted edge kinds never shipped — marked not-pursued;OWNED_BYclarified as blame-level.edges.tscount of 25.Release/changelog
release.yml+RELEASE.md: reframed npm publish as single-package + OIDC live (run chore: release main #176 shipped 0.6.0 w/ provenance).scripts/smoke-mcp.sh:EXPECTED_TOOLS29 → 28(functional defect — smoke would fail against the real server) + roster comment corrected.CHANGELOG.md: removed the orphaned[Unreleased]block (release-please owns the file).Code cleanup
Deleted two dead
@deprecatedshims (zero in-repo importers):@opencodehub/analysiswiki re-exports, andLSP_PROVENANCE_PREFIXES+ its core-types barrel re-export.enginesfloor bump drops Node 20 (defensible — CI matrix is[22,24]), but it's a user-visible policy decision.packages/core-types/README.md:45still names the deletedLSP_PROVENANCE_PREFIXES(prose only, not a build break).🤖 Surfaced by an automated roadmap-survey workflow; implemented + verified in an isolated worktree.