Update documentation for version 3.0 #26
Open
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
- Add docs/ru/releases/3.0.md with v3.0.0 release documentation - Cover Stroma architecture and hook system - Document dynamic options (target, Range support, validation) - Include stage improvements and extensions integration - Add RSpec Test Kit redesign and Fluent API - Document Rails generators (install, service, rspec, extension) - Add i18n locales (de, fr, es, it) and Ruby/Rails compatibility
- Replace numbered lists with bullet points for consistency - Align formatting with other release notes files
- Translate all release notes (2.2-3.0) to English - Create docs/releases/ directory with 16 translated files - Enable releases nav and sidebar in English config - Add Release 3.0 to English sidebar - Update Russian nav link from 2.16 to 3.0 - Add Release 3.0 to Russian sidebar
- Split RSpec docs into fluent (new) and legacy sections - Add fluent.md documenting allow_service/allow_service! helpers - Move existing docs to legacy.md with deprecation notice - Update sidebars to show new helpers first - Add redirects from old URLs to legacy documentation - Document chainable methods: succeeds, fails, with, then_* - Document argument matchers: including, excluding, any_inputs - Include matchers section in both EN and RU versions
✅ Deploy Preview for servactory ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Change deprecation link text to "new testing API" - Remove deprecated valid_with from fluent documentation - Fix types examples by renaming ids to id - Remove duplicate be_success_service assertion in examples - Add target option documentation for have_input and have_internal - Fix dead links in release notes 2.5 and 2.9
- Replace OrderService::Create with UsersService::Create example - Fix double service call issue (result was discarded in first call) - Store service result in internals.email_verification properly - Add internals validation block with have_internal matcher - Add last_name input test with .optional chain - Use canonical describe block naming from Servactory spec pattern - Apply same changes to both EN and RU locales
- Add :aggregate_failures tag to enable multiple assertions - Use block form of raise_error matcher to access exception object - Check exception class via be_a matcher - Add explicit checks for type, message, and meta attributes - Apply same changes to both EN and RU locales
- Document step-by-step migration from Legacy to Fluent RSpec helpers. - Provide examples for success/failure mocks and input matching. - Highlight new Fluent API features: sequential calls, custom exceptions. - Compare Legacy vs. Fluent APIs in a detailed reference table. - Add migration links to Legacy documentation in EN and RU locales. - Update navigation configs to include new guide in both languages.
- Add "Failure with Custom Exception Class" section to migration guide - Update navigation labels to "RSpec Migration" / "Миграция RSpec" - Fix prev/next metadata in extensions.md and legacy.md files
- Add target to list of dynamic options in dynamic.md (EN/RU) - Add full target section with installation and usage examples - Add stub sections in usage.md linking to dynamic.md (EN/RU) - Follow existing pattern for dynamic options not enabled by default
- Replace deprecated with_extensions API with new extensions block syntax - Document before/after hooks, available keys, and execution order - Explain super call chain and extension patterns (before, around, after, rescue) - Add Stroma settings structure with auto-vivification - Include practical examples: Authorization, Transactional, Publishable, Rollbackable - Add migration guide from 2.x to 3.0 syntax - Add cross-references from release notes to extensions docs
- Replace method-style calls with Servactory .call! pattern - Fix PaymentGateway.charge to PaymentsService::Charge.call! - Fix InventoryService.reserve/release to nested service calls - Replace reserved word 'transaction' with 'payment' output - Use .present? for conditional checks
- Use descriptive attribute name for better clarity
- Remove Extension postfix from AuthorizationExtension, PublishableExtension - Use consistent full namespace ApplicationService::Extensions::*::DSL
- 2.x used attr_accessor (class instance variable), not @@var - Verified against actual v2.16.1 source code
- Replace validate_something!/log_result! with inline code examples - Add "Organizing complex extensions" section with Tools pattern - Document file structure for extensions with Tools classes - Based on Servactory internal workspace.rb pattern
- Tools classes are PORO, not Servactory services - Add clarifying comment above Tools class invocation
- Add GitHub link for Stroma hook system reference - Update both English and Russian documentation
- Add GitHub link for Stroma in 3.0 release notes - Update both English and Russian documentation
- Add "Root key for I18n" section to EN configuration guide - Add "Корневой ключ для I18n" section to RU configuration guide - Include code example and link to I18n documentation
- Add generators.md page for English and Russian - Add Rails section to sidebar navigation - Update prev/next links in extensions and i18n pages - Add link to generators from getting-started page
- Rename date attributes to use _on suffix convention - Fix Russian description wording
- Remove badge from page title - Add version badge to each generator heading
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.
No description provided.