Repository navigation
docs: separate the workspace-internal packages from the published ones - #114
Merged
Merged
Conversation
The Packages table listed nine entries and meant two different things by them. Eight are on npm; `discover-feed` is `"private": true` and its own README opens with "Internal, workspace-only package." Someone reading the table had no way to tell, and `npm i @opentechevents/discover-feed` 404s. `feed-urls` and `preview-feed` were missing from the table entirely — also internal, so leaving them out was consistent, but it left the repo with no single place that says what they are or who uses them. So the published table now holds only published packages, and the three internal ones get their own table with the thing that actually matters about them: which apps depend on them. All three exist for the same reason — two apps in this repo needed the same logic and a second copy would have drifted — and none carries a compatibility promise. Also corrects the versioning sentence: `migrate` does not follow the spec minor it implements, because it spans versions rather than implementing one. Co-Authored-By: Claude Opus 5 <[email protected]>
The repo implements OTE Spec 0.6.0 — the badge at the top of the README and the versioning sentence below the table both still claimed 0.4. The badge is the first thing a visitor reads about which spec this kit speaks. Co-Authored-By: Claude Opus 5 <[email protected]>
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.
The Packages table listed nine entries and meant two different things by them. Eight are on npm;
discover-feedis"private": trueand its own README opens with "Internal, workspace-only package." A reader had no way to tell, andnpm i @opentechevents/discover-feed404s.feed-urlsandpreview-feedwere missing from the table entirely — consistent with being internal, but it left no single place saying what they are or who uses them.Now: the published table holds only published packages, and the three internal ones get their own table with the thing that matters about them — which apps depend on them.
Also corrects the versioning sentence:
migratedoes not follow the spec minor it implements, because it spans versions rather than implementing one.Docs only; no code touched.
🤖 Generated with Claude Code