Overview
The purpose of a landing page is to welcome users and provide an overview of the product.
Accessible, welcoming, conversational, outspoken
overview
Metadata title: Overview
Title: Name of the product, group of products, or conceptual content area. H1. Usually a noun. Do not add "documentation" to the title. Do not use gerund phrases.
Intro/overview: Brief welcoming introductory content. May be combined with product description.
Product description: What does this product do? Why would you use it?
Product availability: What plan(s) is this available to? Review available plan types ↗.
Product attributes: What is included with this product? (Specific actions, protections, etc.)
Features: A few main features specific to product. Includes a link to relevant documentation on feature.
Related products: Links to documentation for products used or configured together with current product.
More resources: External links to related resources, such as plans, pricing. Do not duplicate the information from the footer. Also, if the product is free to use or there are not any useful links, feel free to skip this section. Review available icons in the source code ↗.
Visual: Graphic or image that enhances the landing page. It should be something relatively static that will not require much (if any) updating in the future.
Integration information
Overview pages are the default "first" page in any nested navigation. In some cases, to ensure good information architecture and navigability, you may need to rename or remove overview pages.
If the overview acts as a table of contents that provides no additional information or context, consider removing it altogether.
Deleting the index.mdx
file in a nested folder is not possible and will result in a build error. To remove the page from the docs, the index.mdx
file must be hidden using sidebar styling changes. Also, to ensure that users do not accidentally access the overview page, add a redirect.
To hide an overview page, set the group.hideIndex
property to true
in the page's frontmatter.
Argo Smart Routing documentation
Images is an example of a product whose availability is complex, and is not easy to just use one type of plan. To create components for each plan type, insert {{</*plan type="<PLAN_TYPE>"*/>}}
below each of the feature component, like so: