docs: expand and reorder the FAQ into a decision gateway#136
Merged
Conversation
Turn the FAQ from a concept-clarifier into a page that answers the real adoption objections a newcomer has. Add four practical questions: - Does FirstClassErrors replace logging? (no — it structures errors; the logging system records occurrences) - Can I adopt FirstClassErrors incrementally? (yes — domain or use case at a time, no global migration) - How do I handle an exception from a third-party library? (model it at the boundary when it is a stable failure; do not first-class every one) - Can error messages be shown to users? (ShortMessage/DetailedMessage are the controlled public messages; DiagnosticMessage stays internal) Reorder the questions into three implicit movements: why use the library, choosing between exceptions/Outcome/technical errors, then documenting and diagnosing. Sharpen a few answers: - Say the library attaches a structured Error to the exception, rather than "enriches the Error carried by" it (the Error is not a standard field of a .NET exception). - Scope the documentation rule to "every first-class error you define". - Give the concrete factory benefit over new: it avoids repeating codes, messages, and metadata across use cases. - Rename the domain-nesting question to "How do I nest the different error categories?" and link the dedicated taxonomy page. The third-party-exception answer states that the first-class error captures the failure's meaning and does not store the caught exception object: DiagnosableException carries only an Error, and Error.InnerErrors nests Errors, not exceptions. The English and French pages stay in sync.
Reefact
enabled auto-merge
July 15, 2026 23:53
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
2 participants
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
Rework the FAQ so it answers the real adoption objections a newcomer has, not only conceptual clarifications. Adds four practical questions, reorders the existing ones into three implicit movements, and sharpens several answers. English and French stay in sync.
Type of change
Changes
Outcome/technical errors → documenting and diagnosing.Errorcarried by that exception" to "attaches a structuredErrorto that exception" (theErroris not a standard field of a .NET exception).FCE009reference.new: it avoids repeating codes, messages, and metadata across use cases.DiagnosableExceptioncarries only anError;Error.InnerErrorsnestsErrors, not exceptions).doc/FAQ.fr.mdin sync withdoc/FAQ.en.md.Testing
Documentation-only change; no source code touched, so no build or test was run.
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)Documentation
doc/updateddoc/FAQ.fr.mdkept in sync withdoc/FAQ.en.md)Architecture decisions
Proposed: ADR-____Related issues
None — editorial documentation improvement.
🤖 Generated with Claude Code
https://claude.ai/code/session_01LUaMS5EHzAdQHBJzrYvKTj
Generated by Claude Code