Refactor all texts #21
Draft
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
…elease notes - Revised the "Начало работы" section to clarify development conventions and installation steps. - Enhanced the "Почему Servactory" section with a detailed overview of the framework's benefits and usage examples. - Updated release notes for versions 2.2 to 2.14, highlighting key changes, improvements, and support for Ruby and Rails versions.
- Revised the "Начало работы" section to provide a clearer introduction to Datory, including installation and setup instructions. - Added sections on nested data handling and examples for DTO creation, serialization, and deserialization. - Enhanced descriptions across various guides to improve clarity and usability for users.
- Updated the "Начало работы с Featury" section to provide a clearer introduction, including installation and setup instructions. - Added detailed development conventions and examples for creating and using features. - Revised the "Информация об объекте Featury" section to clarify methods for retrieving feature information and their structure.
- Updated the "Getting Started with Featury" section to enhance the introduction and installation instructions. - Improved the structure and content of the "Development Conventions" and "Version Support" sections. - Enhanced the "Featury Actions" and "Callbacks" documentation for better understanding. - Revised various sections for consistency in terminology and formatting across the documentation.
✅ Deploy Preview for servactory ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…nto docs/refactoring
There was a problem hiding this comment.
Pull Request Overview
This PR refactors and standardizes documentation across the Datory and Featury guides by updating frontmatter descriptions, normalizing heading styles, and expanding examples for clarity.
- Updated frontmatter
descriptionfields for more precise context - Standardized heading capitalization and naming conventions
- Added new introductory sections and code examples in both English and Russian docs
Reviewed Changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ru/datory/guide/usage/deserialization.md | Expanded page description with specific focus |
| docs/ru/datory/guide/info.md | Added overview of info and describe methods |
| docs/ru/datory/guide/data/nesting.md | Clarified nesting methods and added full examples |
| docs/ru/datory/guide/data/attributes.md | Detailed attribute helper descriptions |
| docs/ru/datory/getting-started.md | Introduced “What is Datory?” and first DTO guide |
| docs/guide/options/usage.md | Capitalized headings and refined option text |
| docs/guide/options/dynamic.md | Normalized dynamic options headings |
| docs/guide/options/advanced.md | Standardized advanced mode headings and notes |
| docs/guide/i18n.md | Minor phrasing adjustments for clarity |
| docs/guide/extensions.md | Refined description and heading for extension guide |
| docs/guide/exceptions/success.md | Revised titles and phrasing for success flow |
| docs/guide/exceptions/failure.md | Standardized method descriptions and error terms |
| docs/guide/configuration.md | Consistent capitalization and phrasing |
| docs/guide/actions/usage.md | Refined action usage wording and headings |
| docs/guide/actions/grouping.md | Updated grouping option headings |
| docs/featury/guide/info.md | Added context sentence about purpose of info |
| docs/featury/guide/features.md | Removed stray blank line |
| docs/featury/guide/callbacks.md | Updated frontmatter titles and descriptions |
| docs/featury/guide/actions.md | Refined overview and example wording |
| docs/featury/getting-started.md | Added “What is Featury?”, conventions, and examples |
Comments suppressed due to low confidence (2)
docs/guide/extensions.md:17
- [nitpick] Consider renaming this heading to “### Connecting” or “### Extension Connection” to clearly indicate the action rather than the noun ‘Connection’.
### Connection
docs/guide/options/usage.md:14
- [nitpick] This fragment is a sentence fragment; consider rephrasing to “It uses the
is_a?method.” for consistency and readability.
Uses the `is_a?` method.
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.