From f0e28f3db048afd0779c3d7b16e3d5e8ad507c80 Mon Sep 17 00:00:00 2001 From: Andrey Helldar Date: Fri, 5 Sep 2025 18:59:05 +0300 Subject: [PATCH 1/2] Improved docs --- docs/topics/receipt-sitemap.topic | 37 +++++++++++++++++++++++------- docs/topics/snippet-generate.topic | 5 ++-- 2 files changed, 31 insertions(+), 11 deletions(-) diff --git a/docs/topics/receipt-sitemap.topic b/docs/topics/receipt-sitemap.topic index 5289503..0af3158 100644 --- a/docs/topics/receipt-sitemap.topic +++ b/docs/topics/receipt-sitemap.topic @@ -6,23 +6,38 @@ xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" title="Sitemap" id="receipt-sitemap" help-id="sitemap"> - Recipe for creating a sitemap - Recipe for creating a sitemap - Recipe for creating a sitemap + How to create a sitemap feed + Step-by-step recipe for creating a sitemap + Step-by-step guide to creating a sitemap feed +

+ 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, and reference the sitemap + from a root sitemap.xml if needed. +

+ +

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

%command-make-simple% Sitemaps/Product -%command-shortcut-item% - + +

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

- + +

+ Define the XML element name and map model properties to sitemap tags: +

@@ -32,14 +47,14 @@

- Don't forget to add a link to the folder with site maps in the + Add a filesystem link to the directory containing your sitemaps in the config/filesystems.php configuration file:

- After that, run the console command: + Then create the public symlink so the files are accessible via the browser:

@@ -51,11 +66,17 @@ - + +

+ If you maintain a root sitemap.xml file that references other sitemaps, add an entry like this: +

+

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

diff --git a/docs/topics/snippet-generate.topic b/docs/topics/snippet-generate.topic index cc80a0e..80c42e2 100644 --- a/docs/topics/snippet-generate.topic +++ b/docs/topics/snippet-generate.topic @@ -9,7 +9,7 @@

- Now you can generate a feed using a console command: + Generate the feed by running the following console command:

@@ -19,8 +19,7 @@

- Check the operation/migration - file that was created for you and run the console command: + Review the generated operation/migration file and then run the appropriate console command:

From 525dbe4e81f32b6987f06f6c5b122d9e5d997f2c Mon Sep 17 00:00:00 2001 From: Andrey Helldar Date: Fri, 5 Sep 2025 19:24:01 +0300 Subject: [PATCH 2/2] Improved documentation for sitemap feed creation and updated phrasing for clarity --- docs/topics/receipt-sitemap.topic | 26 ++++++++++++++------------ docs/topics/snippet-generate.topic | 2 +- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/topics/receipt-sitemap.topic b/docs/topics/receipt-sitemap.topic index 0af3158..04eaed2 100644 --- a/docs/topics/receipt-sitemap.topic +++ b/docs/topics/receipt-sitemap.topic @@ -6,21 +6,23 @@ xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" title="Sitemap" id="receipt-sitemap" help-id="sitemap"> - How to create a sitemap feed - Step-by-step recipe for creating a sitemap - Step-by-step guide to creating a sitemap feed + 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 feed

- 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, and reference the sitemap - from a root sitemap.xml if needed. + 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

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

%command-make-simple% Sitemaps/Product -%command-shortcut-item% @@ -29,14 +31,14 @@

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

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

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

- Add a filesystem link to the directory containing your sitemaps in the - config/filesystems.php configuration file: + Add a filesystem 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 via the browser: + Then create the public symlink so the files are accessible in the browser:

diff --git a/docs/topics/snippet-generate.topic b/docs/topics/snippet-generate.topic index 80c42e2..d09413d 100644 --- a/docs/topics/snippet-generate.topic +++ b/docs/topics/snippet-generate.topic @@ -19,7 +19,7 @@

- Review the generated operation/migration file and then run the appropriate console command: + Review the generated operation or migration file, then run the appropriate console command: