docs(sdks): document C# generate-documentation-file and package-metadata config - #6720
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(sdks): document C# generate-documentation-file and package-metadata config#6720devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…ata config Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1787418535-csharp-package-metadata-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
The C# SDK generator now lets customers control two things about the package they ship.
package-metadatafills in the NuGet listing: their own description, authors, tags, copyright, icon, and project/repository links, plus optional source-linked builds and a.snupkgsymbol package for debugging.generate-documentation-file(on by default) controls whether the package ships an XML documentation file, which is what drives IntelliSense for SDK consumers. Neither was documented, so customers had no way to discover them.Implements docs for: fix(csharp): honor ClientOptions global headers, fix README snippets and XML docs, add docs/NuGet metadata config (fern-api/fern#17471)
Pages changed
fern/products/sdks/generators/csharp/configuration.mdx: addedgenerate-documentation-fileand apackage-metadatablock (parent option with agenerators.ymlexample, then one<ParamField>per key using the page's existing dotted-path convention), in the page's alphabetical order. Each key names the.csprojproperty it sets, the defaults Fern derives from the GitHub output location forproject-url/repository-url, and the list-joining behavior forauthors(commas) andtags(semicolons).fern/products/sdks/generators/csharp/publishing-to-nuget.mdx: one sentence at the end of Configure SDK package settings pointing atpackage-metadataon the configuration page — the NuGet listing fields are what a reader on this page would be looking for, and the detail isn't duplicated.Option names, types, defaults, and property mappings were taken from
CsharpConfigSchema.ts,generation-info.ts(generate-documentation-filedefaults totrue),CsharpProject.ts, and the generated.csprojin the newcsharp-xml-entities/package-metadataseed fixture.Validation:
pre-commit run(Vale: 0 errors; remaining warnings/suggestions are pre-existing) andfern check --warnings(0 errors, no new warnings).Link to Devin session: https://app.devin.ai/sessions/968f5c82f6cc4c07bdf5e1e7af4b61a3