-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: establish v4 onboarding contract #1895
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,15 @@ | ||
| --- | ||
| id: package-selection | ||
| title: Choose the right package | ||
| title: Package selection | ||
| sidebar_position: 3 | ||
| diataxis: explanation | ||
| diataxis: how-to | ||
| persona: developer choosing dependencies | ||
| --- | ||
|
|
||
| import CodeBlock from '@theme/CodeBlock'; | ||
| import quickStart from '!!raw-loader!../_examples/quick-start/Program.cs'; | ||
| # Package selection | ||
|
|
||
| # Choose the right package | ||
| Humanizer 4 has one package: `Humanizer`. Follow the | ||
| [installation guide](./installation.mdx) to add it. | ||
|
|
||
| ## Orientation | ||
|
|
||
| For ordinary applications, install `Humanizer`. That name is stable even though the package's internal layout changed across release lines. | ||
|
|
||
| | Documentation version | Normal install | Package shape | | ||
| | --- | --- | --- | | ||
| | `2.10.1` through `3.0.10` | `Humanizer` | Metapackage that brings in `Humanizer.Core` and locale packages | | ||
| | `4.0` | `Humanizer` | Consolidated library with runtime, generated locale data, and analyzers | | ||
|
|
||
| The API reference for releases through `3.0.10` is generated from `Humanizer.Core`, because that is where the public implementation assembly lives. That does not change the normal install command. | ||
|
|
||
| ## Example | ||
|
|
||
| Install Humanizer from NuGet: | ||
|
|
||
| ```console | ||
| dotnet add package Humanizer --version 4.0.0 | ||
| ``` | ||
|
|
||
| Then use the same `Humanizer` namespace regardless of package layout. This | ||
| verified program is compiled against the selected package: | ||
|
|
||
| <CodeBlock language="csharp" title="Program.cs">{quickStart}</CodeBlock> | ||
|
|
||
| Choose `Humanizer.Core` directly only when you deliberately want the older release line's English-only core or must work around tooling that cannot restore its locale metapackage. Add only locale packages that exist for that exact release. | ||
|
|
||
| ## Pitfall | ||
|
|
||
| Do not copy `Humanizer.Core.<locale>` references from a historical release into | ||
| Humanizer 4. Locale packaging is version-specific, and package names are not | ||
| proof that an API is present in another release. | ||
|
|
||
| ## Version notes | ||
|
|
||
| Package selection is a compatibility concern, not an API preference. Keep the documentation selector aligned with `project.assets.json` or your lock file when diagnosing restore or runtime behavior. | ||
|
|
||
| ## Related guides and API | ||
|
|
||
| - [Installation](./installation.mdx) | ||
| - [Localization and extensibility](../scenarios/localization-and-extensibility.mdx) | ||
| - [Selected-version API reference](../api/index.md) | ||
| This page remains available for existing inbound links. If you are moving from | ||
| an earlier release, use the [upgrade guide](../upgrading/index.mdx). |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.