Conversation
Addresses #453: overhaul documentation to be a clear, authoritative technical guide to creating type providers. Changes: - docs/guide.md (new): 700-line comprehensive guide covering: - Erased vs generative type providers - Step-by-step erased provider (properties, methods, constructors, state) - Static parameters (required and optional with defaults) - Quotations, cross-targeting, UncheckedQuotations - Generative provider basics and differences from erased - Interfaces, enumerations, nested types, events, fields - XML documentation, custom attributes, units of measure - nonNullable and hideObjectMethods - Abstract classes and base constructor calls - Testing with ProvidedTypesTesting - Packaging (NuGet layout, bundling dependencies) - Common pitfalls summary table Each section references the matching test file in tests/ - docs/index.md: rewritten as a navigation landing page with table linking to guide, technical-notes, and debugging pages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
7 tasks
dsyme
approved these changes
Feb 26, 2026
This was referenced Feb 26, 2026
dsyme
pushed a commit
that referenced
this pull request
Mar 7, 2026
🤖 *This PR was created by Repo Assist, an automated AI assistant.* Prepares the RELEASE_NOTES.md for version **8.3.0** — a minor release capturing significant improvements merged since 8.2.0 (February 24). ## Changes since 8.2.0 | Type | PR | Description | |------|----|-------------| | 🐛 Bug fix | #432 | Fix custom attributes on nested erased types | | 🐛 Bug fix | #458 | Fix `GetNestedType` on `TypeSymbol`/`ProvidedTypeSymbol` for generic provided types | | 🐛 Bug fix | #459 | Fix mutable variable captures in `QuotationSimplifier` — promote to ref cells | | ⚡ Performance | #443 | Memoize `transType` in `AssemblyCompiler` to reduce redundant type translation | | ⚡ Performance | #457 | Cache `transTypeRef` and `transMethRef` in assembly compiler | | ✨ Feature | #428 | New warning when all static parameters in a type provider are optional | | 📚 Docs | #455 | Documentation guide overhaul | | 🧪 Tests | #442 | Add coverage tests and Coverage build target | | 🔧 Toolchain | #431 | Update to .NET 8 SDK and toolchain | This is a minor version bump (8.2.0 → 8.3.0) due to the new feature (#428) and significant improvements. If preferred, a patch release (8.2.1) is also reasonable given the emphasis on bug fixes. ## Test Status This PR only modifies RELEASE_NOTES.md. The build/test status for the underlying changes is tracked in the individual PRs listed above (all passed CI before merging). --- *To release: merge this PR, then tag `v8.3.0` and publish the NuGet package via the existing build pipeline.* > Generated by [Repo Assist](https://github.com/fsprojects/FSharp.TypeProviders.SDK/actions/runs/22448247879) > > To install this [agentic workflow](https://github.com/githubnext/agentics/tree/afb00b92a9514fee9a14c583f059a03d05738f70/workflows/repo-assist.md), run > ``` > gh aw add githubnext/agentics@afb00b9 > ``` <!-- gh-aw-agentic-workflow: Repo Assist, engine: copilot, id: 22448247879, workflow_id: repo-assist, run: https://github.com/fsprojects/FSharp.TypeProviders.SDK/actions/runs/22448247879 --> <!-- gh-aw-workflow-id: repo-assist --> --------- Co-authored-by: Repo Assist <github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Addresses #453 — "Completely overhaul docs".
What this PR does
New file:
docs/guide.md— a 700-line comprehensive guide covering:ProvidedTypeBuilder.MakeGenericType,UncheckedQuotations, cross-targeting rulesProvidedAssembly,isErased = false, key differences from erasedargssemantics), events, fields,AddMembersDelayedisInterface = true,AddInterfaceImplementation,DefineMethodOverrideSetEnumUnderlyingType,ProvidedField.LiteralAddNestedTypesAddXmlDoc,AddXmlDocDelayedAddCustomAttributeon types, methods, properties, parametersProvidedMeasureBuilder, compound unitsnonNullableandhideObjectMethodsIsImplicitConstructor,BaseConstructorCallProvidedTypesTesting,MakeSimulatedTypeProviderConfig,GenerateProvidedTypeInstantiationEach section includes a "Test coverage" note pointing to the matching test file in
tests/.Updated:
docs/index.md— rewritten as a navigation landing page with a table linking to the guide, technical notes, and debugging pages, and a summary of what the SDK is.Test Status
Documentation-only change — no compilation artifacts affected. The code samples in the guide are backed by existing tests:
tests/BasicErasedProvisionTests.fstests/BasicGenerativeProvisionTests.fstests/GenerativeInterfacesTests.fstests/GenerativeEnumsProvisionTests.fstests/GenerativeAbstractClassesTests.fsNotes for maintainer
This is a first substantial pass. Follow-on work tracked in #453 could include:
examples/