Documentation update#850
Open
BaalEvan wants to merge 2 commits into
Open
Conversation
Docs Deploy
|
@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. |
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.
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.mdxcomparing/migration-from-zenject.mdx(split out ofcomparing-to-zenject, which is now trimmed)diagnostics/troubleshooting.mdxextensions/creating-extensions.mdxrecipes/common-recipes.mdxregistering/register-generics.mdxregistering/register-instance.mdxregistering/register-parameters.mdxregistering/register-with-keys.mdx(expanded)scoping/instance-sharing-example.mdxtesting/unit-testing.mdxRestructure
registering/register-type.mdx→registering/register-plain-csharp.mdxwith rewritten contentsidebars.ts) anddocusaurus.config.tsupdated to match the new structureStyling & readability
CodeBlockInTable,CodeSizeGraph,GCAllocGraph,GraphThemeContextJapanese i18n
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.mdx→registering/register-plain-csharp.mdxModified (existing JA translations are now stale):
about/what-is-di.mdxabout/what-is-vcontainer.mdxcomparing/comparing-to-zenject.mdxdiagnostics/diagnostics-window.mdxgetting-started/hello-world.mdxgetting-started/installation.mdxintegrations/ecs.mdxintegrations/entrypoint.mdxintegrations/unitask.mdxoptimization/async-container-build.mdxoptimization/parallel-container-build.mdxoptimization/source-generator.mdxregistering/register-callbacks.mdxregistering/register-collection.mdxregistering/register-factory.mdxregistering/register-monobehaviour.mdxregistering/register-scriptable-object.mdxregistering/register-using-delegate.mdxregistering/register-with-keys.mdxresolving/constructor-injection.mdxresolving/container-api.mdxresolving/gameobject-injection.mdxresolving/method-injection.mdxresolving/property-field-injection.mdxscoping/generate-child-via-scene.mdxscoping/generate-child-with-code-first.mdxscoping/lifetime-overview.mdxTooling
website/package.json+package-lock.jsondependency bumpsPreview 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