docs: align all documentation and XML comments with Axlis.ORM naming and current API - #41
Merged
Merged
Conversation
…site-context docs - Update the PR readiness checklist to use a generic shipped-code reference rule - Replace branded ISiteContext XML doc examples with neutral site key examples
…fication - Add 0.2.0 release notes covering package-family rename, namespace updates, DI naming changes, solution/docs restructuring, and CI/CD updates - Clarify that milestone artifacts remained at package version 0.1.0 despite the v0.2.0 tag - Add a 0.1.0 dated section and update comparison links for Unreleased, 0.2.0, and 0.1.0
- Update code style namespace example to reflect the current package naming - Revise release documentation guidance to note prior naming drift and reinforce re-validation on each release
- Replace the outdated file-scoped namespace sample with the Axlis.ORM.Core form
- Correct the de-branding section to reference Axlis.ORM.Core explicitly - Update tone guidance to describe stale API-name references as a resolved historical drift example
…or across guides - Update architecture and template documentation to consistently use Axlis.ORM package and namespace names - Refresh getting-started installation and registration samples to use current package IDs and AddAxlisORM/AddAxlisORMGraphQL configuration binding - Clarify axes lazy-loading depth behavior and cache setup guidance with current extension-method naming - Move templates documentation into the orm docs section and modernize version wording
…gistration pattern - Refresh XML docs and project guidance to reference Axlis.ORM naming and AddAxlisORM registration methods - Update package README setup example to show explicit options binding for AddAxlisORM/AddAxlisORMGraphQL and UseAxlis initialization - Improve facade usage sample to demonstrate typed Axes child retrieval - Strengthen workflow guidance to enforce documentation sync when registration APIs evolve
… with Axlis.ORM branding - Rename Abstractions README title and install command to Axlis.ORM.Abstractions - Update package description text to reference Axlis.ORM naming - Correct XML documentation references to Axlis.ORM and Axlis.ORM.GraphQL implementations
… Axlis.ORM conventions - Rename Core package README references and install command to Axlis.ORM.Core naming - Refresh documentation links to the current orm templates guide location - Update XML docs to reference Axlis.ORM.GraphQL and clarify UseAxlis-based lazy-loader wiring at startup
…registration API - Rename package title and description references to Axlis.ORM.GraphQL conventions - Update install command to the current package ID - Replace legacy DI extension usage with AddAxlisORM and AddAxlisORMGraphQL examples
- Correct the root guidance link reference for the cache manager fragile-zone note - Update maintenance guidance to frame legacy AddAxlis naming as historical drift already fixed and to prevent recurrence
…ge name - Replace legacy Axlis package reference with Axlis.ORM in caching ownership documentation
- Replace legacy AddAxlisGraphQL reference with AddAxlisORMGraphQL in transport configuration guidance
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.
Sweeps the entire repository — docs, READMEs, XML doc comments, agent guides, and the changelog — to resolve naming drift introduced by the 0.2.0 rename milestone. No compiled or shipped code logic was changed; this is a documentation-only update.
What changed
CHANGELOG.mdto document the 0.2.0 rename milestone, clarify the versioning note (git tag vs. NuGet version), and add correct comparison links forv0.1.0andv0.2.0.docs/orm/guides (Architecture.md,GettingStarted.md,Caching.md,Axes.md,Templates.md) with the current package names (Axlis.ORM,Axlis.ORM.Core,Axlis.ORM.GraphQL,Axlis.ORM.Abstractions), DI registration methods (AddAxlisORM(),AddAxlisORMGraphQL()), and namespace conventions.docs/Templates.mdunderdocs/orm/to match the reorganized docs structure.docs/WORKFLOW.mdto reflect current branch/commit/release conventions and remove stale content.CONTRIBUTING.mdnamespace example toAxlis.ORM.*and removed legacy brand examples from the de-branding checklist.WORKFLOWS.mdto align process steps with current naming and commit policy.CLAUDE.mdroot guide to tighten de-branding wording and documentation-drift guidance.README.mdfiles (Axlis.ORM,Axlis.ORM.Core,Axlis.ORM.GraphQL,Axlis.ORM.Abstractions) to reflect current package identities, installation instructions, and DI wiring.ISitecoreFacade,ISitecoreService,ISiteContext,IGraphQLTransport,IItemLazyLoader,ItemConverter,ExtendedItem,SitecoreService, andAxlisGraphQLOptionsto reference current type names and package context.src/Axlis.ORM/Caching/CacheManager.mdandsrc/Axlis.ORM/CLAUDE.mdto fix stale links and naming references.Why
The 0.2.0 rename was applied to source code and solution structure but left a trail of stale names across docs and XML comments. These inconsistencies were flagged in
CLAUDE.mdas the exact class of drift to watch for (AddAxlis()/AddAxlisGraphQL()references, etc.). This PR closes that gap so the documentation is an accurate reflection of the current codebase.