docs: the packages import as sillo_wire and sillo_graphql - #445
Merged
Merged
Conversation
Follows sillohq/wire#1 and sillohq/graphql#1, which remove the `sillo.wire` and `sillo.graphql` import aliases. Both packages are plain top-level distributions now, so the docs teach the top-level names. Safe to land ahead of those PRs: `sillo_wire` already works in the published 0.1.0.dev1, which answers to both names. Rewrites the prose that explained the aliasing rather than just swapping imports under it. The "two import paths" sections in the Wire and GraphQL manuals are gone; the Packages index's "How they attach" section no longer describes a meta-path finder and a second set of stubs, and says what happened to the aliases instead. Three things are deliberately left alone: - `v0.x/guides/graphql.md` is untouched. It documents the framework's own built-in `sillo.graphql` on the 0.x line, which is a different thing that still exists there. - Logger names. `sillo.graphql.operations` in the observability page is a logging hierarchy under the framework's `sillo` logger, not an import. - References to the pre-1.0 `sillo.graphql` the framework shipped, which are accurate history and are what the migration tables migrate from. The v0.x and v1.0 caveats saying `sillo-graphql` "claims the same import name" and so "refuses to load" against 0.x were describing a collision that no longer exists. What actually rules it out on 0.x is the version floor, which is what they now say. Verified: docs build clean (526 pages), no broken internal links.
|
Deployment failed for project nexios with the following error: |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Docs half of the import-path change. Companion to sillohq/wire#1, sillohq/graphql#1 and sillohq/vise#1.
Wire and GraphQL shipped under two names —
sillo_wirewhere the code lives, andsillo.wireas an alias so an import read as part of the framework. Those aliases are being removed, so the docs teach the top-level names.Safe to merge ahead of the package PRs.
sillo_wirealready works in the published0.1.0.dev1, which answers to both names, so nothing here is wrong before or after they land.Prose, not just imports
The alias had documentation of its own, and swapping the import statements under it would leave pages explaining machinery that no longer exists:
.pthand PEP 561 stubs; it now says packages are plain top-level distributions, keeps the part that still matters (nothing is installed into the framework'ssillo/directory, and why), and records what happened to the aliases.sillo-graphql"claims the same import name" and therefore "refuses to load" against 0.x. That collision no longer exists — what actually rules it out on 0.x is thesillo-framework>=1.0floor, which is what they now say.Deliberately unchanged
v0.x/guides/graphql.md— untouched. It documents the framework's own built-insillo.graphqlon the 0.x line. That module is real and still there; it is not this package.sillo.graphql.operationson the observability page is a logging hierarchy nested under the framework'ssillologger, the same assillo.recordandsillo.mail. Not an import path.sillo.graphqlthe framework shipped — accurate history, and what the migration tables migrate from.Verification
26 files changed. Docs build clean (526 pages, exit 0) and no broken internal links.
🤖 Generated with Claude Code