docs: update namespace references and add DecoWeaver deprecation notice#42
Conversation
…Weaver package Updates all code examples in README and docs to use the new `LayeredCraft.DecoWeaver.Attributes` namespace and `LayeredCraft.DecoWeaver` package name. Adds a deprecation callout in README, docs/index.md, and the installation guide directing users to migrate from the old `DecoWeaver` package. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0b68ad28e1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **DecoWeaver.Attributes.dll** - Runtime attributes (zero footprint with `[Conditional]`) | ||
| - **DecoWeaver.dll** - Source generator (build-time only) | ||
| - **LayeredCraft.DecoWeaver.Attributes.dll** - Runtime attributes (zero footprint with `[Conditional]`) | ||
| - **LayeredCraft.DecoWeaver.Generators.dll** - Source generator (build-time only) |
There was a problem hiding this comment.
The package-contents section now says the source generator file is LayeredCraft.DecoWeaver.Generators.dll, but the generator project explicitly packs $(AssemblyName).dll with AssemblyName set to $(PackageId) and PackageId=LayeredCraft.DecoWeaver (src/LayeredCraft.DecoWeaver.Generators/LayeredCraft.DecoWeaver.Generators.csproj, properties and pack item). This means consumers will actually see LayeredCraft.DecoWeaver.dll, so the current text sends users to the wrong filename when validating package contents (and the same naming assumption is repeated in generated-path instructions).
Useful? React with 👍 / 👎.
ncipollina
deleted the
docs/update-namespace-references-layeredcraft-decoweaver
branch
1 participant
Summary
Updates all documentation and README to reflect the rename from
DecoWeavertoLayeredCraft.DecoWeaver. All code examples now use the correct namespace and package name, and a deprecation callout is added in the key entry points to guide users migrating from the old package.Changes
Deprecation notices added (3 locations)
README.md— blockquote callout above the Installation sectiondocs/index.md— MkDocs!!! warningadmonition above Installationdocs/getting-started/installation.md—!!! warningadmonition after the package reference examplesNamespace and package name updates (7 files)
using DecoWeaver.Attributes;→using LayeredCraft.DecoWeaver.Attributes;in all code examplesdotnet add package DecoWeaver→dotnet add package LayeredCraft.DecoWeaverInstall-Package DecoWeaver→Install-Package LayeredCraft.DecoWeaver<PackageReference Include="DecoWeaver"→<PackageReference Include="LayeredCraft.DecoWeaver"LayeredCraft.DecoWeaverFiles updated:
README.md,docs/index.md,docs/getting-started/installation.md,docs/getting-started/quick-start.md,docs/usage/class-level-decorators.md,docs/usage/assembly-level-decorators.md,docs/examples/index.md,docs/api-reference/attributes.md,docs/advanced/source-generators.mdSolution file:
LayeredCraft.DecoWeaver.slnx— addsinstance-registrations.mdto the advanced docs folder.Validation
using DecoWeaver.Attributes;,dotnet add package DecoWeaver, orpackages/DecoWeaver/references in docs or README (outside of intentional migration guidance text)🤖 Generated with Claude Code