Skip to content

Documentation update#850

Open
BaalEvan wants to merge 2 commits into
hadashiA:masterfrom
Porttato:documentation-update
Open

Documentation update#850
BaalEvan wants to merge 2 commits into
hadashiA:masterfrom
Porttato:documentation-update

Conversation

@BaalEvan

@BaalEvan BaalEvan commented Apr 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Major refresh of the Docusaurus website with new documentation pages, restructured registration topics, a refreshed visual style, and Japanese i18n scaffolding so the site builds in JA (content not yet translated, because I don't know Japanese, sorry ;/ ).

New pages

  • best-practices.mdx
  • comparing/migration-from-zenject.mdx (split out of comparing-to-zenject, which is now trimmed)
  • diagnostics/troubleshooting.mdx
  • extensions/creating-extensions.mdx
  • recipes/common-recipes.mdx
  • registering/register-generics.mdx
  • registering/register-instance.mdx
  • registering/register-parameters.mdx
  • registering/register-with-keys.mdx (expanded)
  • scoping/instance-sharing-example.mdx
  • testing/unit-testing.mdx

Restructure

  • registering/register-type.mdxregistering/register-plain-csharp.mdx with rewritten content
  • Sidebar (sidebars.ts) and docusaurus.config.ts updated to match the new structure
  • Lifetime overview, scoping, factory/collection/monobehaviour/delegate registration, and resolving pages revised for clarity

Styling & readability

  • Updated CSS, so links look a bit better and have better contrast (I focused mostly on DarkMode)
  • Minor tweaks to CodeBlockInTable, CodeSizeGraph, GCAllocGraph, GraphThemeContext

Japanese i18n

  • Mirrored new MDX files into i18n/ja/docusaurus-plugin-content-docs/current/... so JA build succeeds. Content is intentionally left in English

!!! Pages requiring JP translation update !!!

All of the following English pages were modified and must be re-translated in i18n/ja/docusaurus-plugin-content-docs/current/:

Renamed:

  • registering/register-type.mdxregistering/register-plain-csharp.mdx

Modified (existing JA translations are now stale):

  • about/what-is-di.mdx
  • about/what-is-vcontainer.mdx
  • comparing/comparing-to-zenject.mdx
  • diagnostics/diagnostics-window.mdx
  • getting-started/hello-world.mdx
  • getting-started/installation.mdx
  • integrations/ecs.mdx
  • integrations/entrypoint.mdx
  • integrations/unitask.mdx
  • optimization/async-container-build.mdx
  • optimization/parallel-container-build.mdx
  • optimization/source-generator.mdx
  • registering/register-callbacks.mdx
  • registering/register-collection.mdx
  • registering/register-factory.mdx
  • registering/register-monobehaviour.mdx
  • registering/register-scriptable-object.mdx
  • registering/register-using-delegate.mdx
  • registering/register-with-keys.mdx
  • resolving/constructor-injection.mdx
  • resolving/container-api.mdx
  • resolving/gameobject-injection.mdx
  • resolving/method-injection.mdx
  • resolving/property-field-injection.mdx
  • scoping/generate-child-via-scene.mdx
  • scoping/generate-child-with-code-first.mdx
  • scoping/lifetime-overview.mdx
  • All newly added mdx

Tooling

  • website/package.json + package-lock.json dependency bumps

Preview of this version with modified config so the deploy job works is available at: https://porttato.github.io/VContainer

Why?

So, I wanted to help my colleagues learn VContainer, as they had issues with some concepts and with how to get started, since there are not many examples available. Then, after I had already started, I thought about improving readability and bumping the Docsaursus version.

You definitely should verify if my additions and examples are correct

@vercel

vercel Bot commented Apr 26, 2026

Copy link
Copy Markdown

@BaalEvan is attempting to deploy a commit to the hadashia's projects Team on Vercel.

A member of the Team first needs to authorize it.

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.

1 participant