From 7f17c1ee16016cef7f3a0b46eacc8812ac4c1c4c Mon Sep 17 00:00:00 2001 From: Andrey Helldar Date: Fri, 5 Sep 2025 20:02:45 +0300 Subject: [PATCH] Updated documentation for consistency and improved phrasing across topics --- docs/topics/advanced-usage.topic | 18 +++++++------- docs/topics/contributions.topic | 4 ++-- docs/topics/create-feeds.topic | 37 ++++++++++++++--------------- docs/topics/generation.topic | 6 ++--- docs/topics/installation.topic | 3 +-- docs/topics/introduction.topic | 2 +- docs/topics/receipt-instagram.topic | 6 ++--- docs/topics/receipt-sitemap.topic | 20 ++++++++-------- docs/topics/receipt-yandex.topic | 8 +++---- docs/topics/snippet-generate.topic | 2 +- 10 files changed, 52 insertions(+), 54 deletions(-) diff --git a/docs/topics/advanced-usage.topic b/docs/topics/advanced-usage.topic index 5ff80bc..9791a04 100644 --- a/docs/topics/advanced-usage.topic +++ b/docs/topics/advanced-usage.topic @@ -29,7 +29,7 @@

- By defending, the name of the root element is formed from the basic name of the feed class. + By default, the name of the root element is derived from the base name of the feed class.

@@ -44,7 +44,7 @@

- To disable the addition of the main element, specify its name as empty - null or + To disable the addition of the root element, specify its name as empty — null or "".

@@ -59,7 +59,7 @@

To add information to the beginning of the root element (if present) or without it, override the - info method in the feed class and call the creation of an object that extend the + info method in the feed class and create an object that extends the DragonCode\LaravelFeed\Feeds\Info\FeedInfo class:

@@ -73,7 +73,7 @@

- If it is necessary to change the procedure for the output of the root element relative to the + If you need to change the order in which the root element is output relative to the information block, set the beforeInfo parameter in the root method:

@@ -135,7 +135,7 @@ Indicates the applicable value "as it is" - Note, that the value of the @value field must be a string. + Note that the value of the @value field must be a string.

@@ -152,7 +152,7 @@ - Allows the use of XML marking without transformation + Allows the use of XML markup without transformation It is also possible to wrap the value of a node into a CDATA section. @@ -173,7 +173,7 @@ - Allows you to use XML marking directly into the structure of the document + Allows you to use XML markup directly within the structure of the document

To insert XML fragments “as is”, use the @mixed directive: @@ -211,7 +211,7 @@

- By default, feeds will be stored in the public storage, + By default, feeds are stored in public storage, and the file name will be automatically generated from the feed class name after App\Feeds\ in kebab-case format. For example: @@ -235,7 +235,7 @@

- Database queries use chunks, which are 1000 bytes by default. + Database queries use chunks, which are 1000 items by default. You can change this by overriding the chunkSize method:

diff --git a/docs/topics/contributions.topic b/docs/topics/contributions.topic index 1f50566..73da10e 100644 --- a/docs/topics/contributions.topic +++ b/docs/topics/contributions.topic @@ -33,7 +33,7 @@ PSR-4 autoloading standard.

- To apply the formatting of the code style, follow the console command: + To apply code style formatting, run the following console command:

composer style @@ -52,7 +52,7 @@

-
  • Participants will be tolerant of opposing views.
    • +
  • Participants should be tolerant of opposing views.
  • Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
    • diff --git a/docs/topics/create-feeds.topic b/docs/topics/create-feeds.topic index fe7f58b..afe246b 100644 --- a/docs/topics/create-feeds.topic +++ b/docs/topics/create-feeds.topic @@ -6,9 +6,9 @@ xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" title="Create feeds" id="create-feeds" help-id="make-feeds;create-feeds;feeds"> - Instructions for creating and filling feed, feed items, and feed info classes - Instructions for creating and filling feed, feed items, and feed info classes - Instructions for creating and filling feed, feed items, and feed info classes + Instructions for creating and populating the feed, feed item, and feed info classes + Instructions for creating and populating the feed, feed item, and feed info classes + Instructions for creating and populating the feed, feed item, and feed info classes @@ -19,7 +19,7 @@ PhpStorm.

    - laravel idea + Laravel Idea

    @@ -35,18 +35,18 @@

    - Also, this console command can create classes of the element and information along with the feed class. - To do this, use --item and --info parameters. + This console command can also create the item and info classes along with the feed class. + To do this, use the --item and --info options.

    - # Create a feed class and information class + # Create a feed class and info class %command-make% --info # Create a feed class and item class %command-make% --item - # Create a feed class, item class and information class + # Create a feed class, item class, and info class %command-make% --item --info @@ -54,46 +54,45 @@ Shortcuts are also available:

    - + # Create a feed class and item class %command-make% -%command-shortcut-item% # Create a feed class and info class %command-make% -%command-shortcut-info% - # Create a feed class, item class and information class + # Create a feed class, item class, and info class %command-make% -%command-shortcut-info%%command-shortcut-item%

    - When creating a feed, an operation/migration will also be created to add it to the database. + When creating a feed, an operation or a migration will also be created to add it to the database.

    - If the project uses the + If the project uses Laravel Deploy Operations - - , then an operation class will be created, otherwise a migration class will be created. + , then an operation class will be created; otherwise, a migration class will be created.

    - This is necessary to add and manage information about feeds in the database. + This is required to add and manage feed information in the database.

    - +

    - Fill in the main feed class. For example: + Populate the main feed class. For example:

    - +

    - Fill in the feed item class. For example: + Populate the feed item class. For example:

    diff --git a/docs/topics/generation.topic b/docs/topics/generation.topic index 69b861f..8b5f452 100644 --- a/docs/topics/generation.topic +++ b/docs/topics/generation.topic @@ -21,7 +21,7 @@

    - As a result, all active feeds (is_active = true) will be launched from the + As a result, all active feeds (is_active = true) will be executed from the feeds table (or the one you specified in the %config-filename% file).

    @@ -33,7 +33,7 @@

    - However, instead of being launched for execution, such feeds will be marked with the + However, instead of being executed, such feeds will be marked with the SKIP status.

    @@ -68,7 +68,7 @@

    - This will enable you to register calls to all active feeds according to the launch schedule you specified in the + This will enable you to register calls to all active feeds according to the schedule you specified in the expression column of the database.

    diff --git a/docs/topics/installation.topic b/docs/topics/installation.topic index b038760..699f9da 100644 --- a/docs/topics/installation.topic +++ b/docs/topics/installation.topic @@ -35,8 +35,7 @@

    - Before running migrations - , check the database connection settings in the + Before running migrations, check the database connection settings in the %config-filename% file.

    diff --git a/docs/topics/introduction.topic b/docs/topics/introduction.topic index 73d7c5b..195767e 100644 --- a/docs/topics/introduction.topic +++ b/docs/topics/introduction.topic @@ -10,7 +10,7 @@ 📃 %instance% - Easy and fast way of exporting a large amount of data to feeds for marketplaces and other consumers. + An easy and fast way to export large amounts of data to feeds for marketplaces and other consumers. diff --git a/docs/topics/receipt-instagram.topic b/docs/topics/receipt-instagram.topic index 3de94d9..1443bd1 100644 --- a/docs/topics/receipt-instagram.topic +++ b/docs/topics/receipt-instagram.topic @@ -12,17 +12,17 @@ - + %command-make-simple% Instagram -%command-shortcut-item% - + - + diff --git a/docs/topics/receipt-sitemap.topic b/docs/topics/receipt-sitemap.topic index 04eaed2..0885101 100644 --- a/docs/topics/receipt-sitemap.topic +++ b/docs/topics/receipt-sitemap.topic @@ -7,7 +7,7 @@ title="Sitemap" id="receipt-sitemap" help-id="sitemap"> How to create a product sitemap feed - Step-by-step guide for creating a product sitemap + Step-by-step guide to creating a product sitemap Step-by-step guide to creating a product sitemap feed @@ -16,11 +16,11 @@ This recipe walks you through creating a product sitemap feed using Laravel Feeds. You will: - Generate the necessary classes - Implement the feed logic - - Expose the files via the filesystem - - Optionally reference the generated sitemap from a root sitemap.xml + - Expose the files via the file system + - Optionally reference the generated sitemap from a root sitemap.xml file

    - +

    Generate the feed and its item class using the following console command:

    @@ -29,16 +29,16 @@     - +

    Implement the feed root element, attributes, query builder, output filename, and item mapping as shown below:

    - +

    - Define the XML element name and map your model properties to the corresponding sitemap tags: + Define the XML element name and map your model’s properties to the corresponding sitemap tags:

    @@ -49,14 +49,14 @@

    - Add a filesystem disk that points to the directory containing your sitemaps in + Add a file system disk that points to the directory containing your sitemaps in the config/filesystems.php configuration file:

    - Then create the public symlink so the files are accessible in the browser: + Then create the public symlink so the files are accessible in a browser:

    @@ -77,7 +77,7 @@

    - A generated sitemap.xml for your products will look like this: + The generated sitemap.xml for your products will look like this:

    diff --git a/docs/topics/receipt-yandex.topic b/docs/topics/receipt-yandex.topic index 7a19f1c..27b9a6d 100644 --- a/docs/topics/receipt-yandex.topic +++ b/docs/topics/receipt-yandex.topic @@ -12,21 +12,21 @@ - + %command-make-simple% Yandex -%command-shortcut-info%%command-shortcut-item% - + - + - + diff --git a/docs/topics/snippet-generate.topic b/docs/topics/snippet-generate.topic index d09413d..f7bd133 100644 --- a/docs/topics/snippet-generate.topic +++ b/docs/topics/snippet-generate.topic @@ -5,7 +5,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" is-library="true" id="snippet-generate" - title="Generate Command"> + title="Generate command">