Skip to content

Refactor all texts - #21

Draft
afuno wants to merge 6 commits into
mainfrom
docs/refactoring
Draft

Refactor all texts#21
afuno wants to merge 6 commits into
mainfrom
docs/refactoring

Conversation

@afuno

@afunoafuno commented Jun 7, 2025

Copy link
Copy Markdown
Member

No description provided.

afuno added 4 commits June 8, 2025 02:33
…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.
@afunoafuno self-assigned this Jun 7, 2025
@afunoafuno added the documentation Improvements or additions to documentation label Jun 7, 2025
@netlify

netlifyBot commented Jun 7, 2025

Copy link
Copy Markdown

Deploy Preview for servactory ready!

NameLink
🔨 Latest commit7d41491
🔍 Latest deploy loghttps://app.netlify.com/projects/servactory/deploys/68487e67115b6c0008033db8
😎 Deploy Previewhttps://deploy-preview-21--servactory.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@afuno
afuno requested a review from CopilotJune 7, 2025 20:53

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 description fields 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
FileDescription
docs/ru/datory/guide/usage/deserialization.mdExpanded page description with specific focus
docs/ru/datory/guide/info.mdAdded overview of info and describe methods
docs/ru/datory/guide/data/nesting.mdClarified nesting methods and added full examples
docs/ru/datory/guide/data/attributes.mdDetailed attribute helper descriptions
docs/ru/datory/getting-started.mdIntroduced “What is Datory?” and first DTO guide
docs/guide/options/usage.mdCapitalized headings and refined option text
docs/guide/options/dynamic.mdNormalized dynamic options headings
docs/guide/options/advanced.mdStandardized advanced mode headings and notes
docs/guide/i18n.mdMinor phrasing adjustments for clarity
docs/guide/extensions.mdRefined description and heading for extension guide
docs/guide/exceptions/success.mdRevised titles and phrasing for success flow
docs/guide/exceptions/failure.mdStandardized method descriptions and error terms
docs/guide/configuration.mdConsistent capitalization and phrasing
docs/guide/actions/usage.mdRefined action usage wording and headings
docs/guide/actions/grouping.mdUpdated grouping option headings
docs/featury/guide/info.mdAdded context sentence about purpose of info
docs/featury/guide/features.mdRemoved stray blank line
docs/featury/guide/callbacks.mdUpdated frontmatter titles and descriptions
docs/featury/guide/actions.mdRefined overview and example wording
docs/featury/getting-started.mdAdded “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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@afuno