Skip to content

Commit 868b35e

Browse files
committed
feat: Update inline guidance
1 parent 88d6222 commit 868b35e

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

archetypes/landing-page.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# The title is the product name
33
title:
4-
# The URL is the base of the deployed path, becoming "docs.nginx/<url>/<other-pages>"
4+
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>"
55
url:
66
# The cascade directive applies its nested parameters down the page tree until overwritten
77
cascade:
@@ -19,33 +19,31 @@ nd-product:
1919
---
2020

2121
## About
22-
2322
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
2423
[//]: # "Use underscores for _italics_, and double asterisks for **bold**."
2524
[//]: # "Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
2625

27-
[//]: # "Give a short 1-2 sentence summary of what the product does and its value to a customer."
28-
This is a short description about a product highlighting key values, mission, or purpose.
26+
[//]: # "This initial section introduces the product to a reader: give a short 1-2 sentence summary of what the product does and its value to the reader."
27+
[//]: # "Name specific functionality it provides: avoid ambiguous descriptions such as 'enables efficiency', focus on what makes it uniquely."
2928

3029
## Featured content
30+
[//]: # "You can add a maximum of three cards: any extra will not display."
31+
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
32+
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
3133

32-
[//]: # "Maximum of three cards available to display."
33-
[//]: # "Each card should be less than 10 words for a description."
34-
[//]: # "If more than three cards are placed here, they are not displayed."
35-
[//]: # "If there is one card, it will take full width and be the only card in the row."
36-
[//]: # "If there is two cards, one card will take half width and there will be two cards in a row."
37-
[//]: # "If there is three cards, there will be two rows, where first row has two equal-sized cards, and second row will have a full width card. Can we inversed in order to feature content."
3834
{{<card-layout>}}
3935
{{<card-section showAsCards="true" isFeaturedSection="true">}}
4036
{{<card title="<some-title>">}}
41-
some-description
37+
<!-- Each description should be roughly 10 words or less. -->
4238
{{</card>}}
39+
<!-- The titleURL and icon are both optional -->
40+
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
4341
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
44-
some-description
42+
<!-- Each description should be roughly 10 words or less. -->
4543
{{</card>}}
4644
{{</card-section>}}
4745
{{</card-layout>}}
4846

4947
## Other content
5048

51-
[//]: # "Provide any sort of additional supporting content you may want customers to see as well (e.g. more cards, diagrams, changelogs, etc.)"
49+
[//]: # "You can add any extra content for the page here, such as additional cards, diagrams or text."

0 commit comments

Comments
 (0)