docs: rebuild the README on the shared q1k-oss skeleton - #3
Merged
Merged
Conversation
Same structure as the other three q1k-oss packages, plus the graph mark from the open-source page with a dark variant. Corrects two claims: engines says node >=18, not 20+, and docker-compose brings up a plain postgres:16-alpine, not an image with Apache AGE already installed.
package.json declared MIT with no LICENSE file alongside it, and had no repository or homepage, so the npm page had nothing linking back. CLAUDE.md named an internal consumer and how it vendors this package; the repo is public, so that is replaced with how the package is meant to be used.
The README was drafted against 0.2.0. On main the package is a library first: the file-upload route and its async orchestration are gone, so their endpoint table is removed, and the new `@q1k-oss/context-engine/extraction` subpath is documented alongside the others. CLAUDE.md keeps its current ADR-037 content, with the internal consumer named generically — the repo is public.
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.
Brings context-engine's README onto the same structure as the other three
q1k-oss packages, and fills in what the repo was missing.
.github/logo.svg,with a dark-mode variant.
LICENSEfile.package.jsondeclared MIT with nothing besideit, and had no
repositoryorhomepage, so the npm page had no linkback to the source.
and
@q1k-oss/context-engine/extractionis listed with the othersubpaths.
enginessaysnode
>=18, not 20+, anddocker-compose.ymlbrings up a plainpostgres:16-alpine, not an image with Apache AGE preinstalled.CLAUDE.mdkeeps its current ADR-037 content, with the internalconsumer referred to generically since this repo is public.
Docs and metadata only;
npm run buildpasses. No version bump, so thepublish workflow will skip.
🤖 Generated with Claude Code