Skip to content

Introduce mod services - #100

Merged
KlaasWhite merged 1 commit into
mainfrom
feature/mod-services
Oct 24, 2026
Merged

KlaasWhite merged 1 commit into
mainfrom
feature/mod-services

Conversation

@KlaasWhite

Copy link
Copy Markdown
Member

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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

@KlaasWhite
KlaasWhite merged commit 5200e47 into main Oct 24, 2026
4 checks passed
@KlaasWhite
KlaasWhite deleted the feature/mod-services branch October 24, 2026 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants