Skip to content

Commit 525dbe4

Browse files
Improved documentation for sitemap feed creation and updated phrasing for clarity
1 parent f0e28f3 commit 525dbe4

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

docs/topics/receipt-sitemap.topic

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,23 @@
66
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
77
title="Sitemap" id="receipt-sitemap" help-id="sitemap">
88

9-
<link-summary>How to create a sitemap feed</link-summary>
10-
<card-summary>Step-by-step recipe for creating a sitemap</card-summary>
11-
<web-summary>Step-by-step guide to creating a sitemap feed</web-summary>
9+
<link-summary>How to create a product sitemap feed</link-summary>
10+
<card-summary>Step-by-step guide for creating a product sitemap</card-summary>
11+
<web-summary>Step-by-step guide to creating a product sitemap feed</web-summary>
1212

1313
<show-structure depth="3" />
1414

1515
<p>
16-
This recipe walks you through creating a product sitemap feed using Laravel Feeds. You will generate the
17-
necessary classes, implement the feed logic, expose the files via the filesystem, and reference the sitemap
18-
from a root sitemap.xml if needed.
16+
This recipe walks you through creating a product sitemap feed using Laravel Feeds. You will:
17+
- Generate the necessary classes
18+
- Implement the feed logic
19+
- Expose the files via the filesystem
20+
- Optionally reference the generated sitemap from a root sitemap.xml
1921
</p>
2022

2123
<chapter title="Create files" id="create_files">
2224
<p>
23-
Generate the feed and its item class using the console command:
25+
Generate the feed and its item class using the following console command:
2426
</p>
2527
<code-block lang="bash">
2628
%command-make-simple% Sitemaps/Product -%command-shortcut-item%
@@ -29,14 +31,14 @@
2931

3032
<chapter title="Fill the feed" id="filling_the_feed">
3133
<p>
32-
Implement the feed root element, attributes, query builder, filename, and item mapping as shown below:
34+
Implement the feed root element, attributes, query builder, output filename, and item mapping as shown below:
3335
</p>
3436
<code-block lang="php" src="receipt-sitemap-feed.php" />
3537
</chapter>
3638

3739
<chapter title="Fill the feed item" id="filling_the_feed_item">
3840
<p>
39-
Define the XML element name and map model properties to sitemap tags:
41+
Define the XML element name and map your model properties to the corresponding sitemap tags:
4042
</p>
4143
<code-block lang="php" src="receipt-sitemap-feed-item.php" />
4244
</chapter>
@@ -47,14 +49,14 @@
4749

4850
<chapter title="Links" id="links">
4951
<p>
50-
Add a filesystem link to the directory containing your sitemaps in the
51-
<a href="https://github.com/laravel/laravel/blob/12.x/config/filesystems.php#L76-L78">config/filesystems.php</a> configuration file:
52+
Add a filesystem disk that points to the directory containing your sitemaps in
53+
the <a href="https://github.com/laravel/laravel/blob/12.x/config/filesystems.php#L76-L78">config/filesystems.php</a> configuration file:
5254
</p>
5355

5456
<code-block lang="php" src="receipt-sitemap-links.php" include-lines="5-" />
5557

5658
<p>
57-
Then create the public symlink so the files are accessible via the browser:
59+
Then create the public symlink so the files are accessible in the browser:
5860
</p>
5961

6062
<code-block lang="bash">

docs/topics/snippet-generate.topic

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
<snippet id="check_operation">
2121
<p>
22-
Review the generated <a href="create-feeds.topic">operation/migration</a> file and then run the appropriate console command:
22+
Review the generated <a href="create-feeds.topic">operation or migration</a> file, then run the appropriate console command:
2323
</p>
2424

2525
<code-block lang="bash">

0 commit comments

Comments
 (0)