docs(contact): standardize @daffodil/contact documentation
#4050
Conversation
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
…documentation Created comprehensive documentation covering all required areas: New documentation: - libs/contact/guides/state.md - Complete state management guide * Documents DaffContactStateModule and DaffContactFacade * All 6 actions with examples (Submit, Success, Failure, Retry, Cancel, Reset) * All 3 selectors (success, error, loading) * Full working component example with template - libs/contact/guides/testing.md - Testing utilities guide * Documents DaffContactStateTestingModule and MockDaffContactFacade * Complete test examples with jasmine-marbles * Shows how to test action dispatch and observable streams Updated documentation: - libs/contact/README.md * Added guides navigation table * Fixed outdated action names (DaffContactSubscribe → DaffContactSubmit) * Fixed incorrect imports (removed non-existent DaffContactSubmission) * Updated all code examples to use current API * Added reference to state guide for detailed info - libs/contact/guides/drivers.md * Fixed import typo (@daffodil/Contact/testing → @daffodil/contact/driver/in-memory) * Fixed Hubspot config import (@daffodil/driver/hubspot) * Removed broken "advanced setup guide" links All 8 requirements from issue graycoreio#2821 are now satisfied: ✓ Package overview ✓ Installation instructions ✓ Usage guidelines ✓ Contact form submission process ✓ State management ✓ Driver details (Hubspot) ✓ Configuration instructions ✓ Testing procedures Closes graycoreio#2821
xelaint
changed the title
@daffodil/contact documentation
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.
PR Checklist
PR Type
Current behavior
Fixes: #2821
New behavior
Created comprehensive documentation covering all required areas:
New documentation:
libs/contact/guides/state.md - Complete state management guide
libs/contact/guides/testing.md - Testing utilities guide
Updated documentation:
libs/contact/README.md
libs/contact/guides/drivers.md
All 8 requirements from issue are now satisfied:
✓ Package overview
✓ Installation instructions
✓ Usage guidelines
✓ Contact form submission process
✓ State management
✓ Driver details (Hubspot)
✓ Configuration instructions
✓ Testing procedures
Breaking change?
Additional context