Repository navigation
Introduce mod services - #100
Merged
Merged
Conversation
There was a problem hiding this comment.
🔵 Needs a closer look
The documentation publishing workflow has unresolved stable/RC concurrency and toolchain compatibility issues.
No open issues 🎉
What changed in this PR
This pull request introduces a cross-mod service registry and migrates documentation builds and publishing from MkDocs/Mike to Zensical.
Changes:
- Adds service registration, retrieval, validation, and dependency-injection support.
- Documents service contracts, dependencies, lifecycle ownership, and usage.
- Updates documentation configuration, CI validation, and stable/RC publishing workflows.
| File | Description |
|---|---|
StarMap.Core/StarMapCore.cs |
Registers the shared service store and scoped mod registry. |
StarMap.Core/Services/ModServices.cs |
Implements cross-mod service storage, validation, and retrieval. |
StarMap.Core/API/ModServiceRegistry.cs |
Adapts the internal service store to the public mod API. |
StarMap.API/Registries/IModServiceRegistry.cs |
Defines the public service registration and retrieval contract. |
requirements-docs.txt |
Replaces MkDocs/Mike dependencies with Zensical. |
README.md |
Updates documentation versioning and RC site information. |
mkdocs.yml |
Removes Mike configuration and adds the mod-services page. |
docs/modding/services.md |
Adds mod-provided services to the service overview. |
docs/modding/mod-services.md |
Documents service contracts, registration, retrieval, and ownership. |
docs/modding/lifecycle.md |
Documents service-registry constructor injection and lifecycle usage. |
docs/modding/index.md |
Links to the mod-services guide. |
docs/modding/dependencies.md |
Documents shared service-contract dependencies. |
docs/modding/constructor-injection.md |
Documents injection and usage of the service registry. |
docs/maintainers.md |
Updates local documentation build and publishing instructions. |
docs/index.md |
Updates documentation versioning information. |
.github/workflows/release.yml |
Invokes reusable documentation publishing for releases. |
.github/workflows/rc-build.yml |
Publishes release-candidate documentation from main. |
.github/workflows/publish-docs.yml |
Builds and deploys stable and RC documentation to GitHub Pages. |
.github/workflows/pr-build.yml |
Uses Zensical for pull-request documentation validation. |
Review effort: Lite
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.
No description provided.