Author landing page descriptions for Experience League
You can achieve consistent presentation for guide descriptions (and links) and on your landing pages. To accomplish this, use the following description metadata fields and keep them to about 20 words in length. This practice consistently displays three lines for descriptions on Experience League.
user-guide-description: For user guides, openTOC.mdand edit the description of your guide. This text describes the entire guide.short-description: For articles, opn thearticle.md, editlanding-page-description, which applies to the page.
You can see this presentation below:
Descriptions get complicated because we use three different descriptions in three different locations, and each have different guidelines.
- Descriptions in Experience League Landings as described above.
- Descriptions in Google search results: (See Description metadata)
- First paragraphs in articles: See Headings and page titles for guidance on regular headings.
More resources:
- See Metadata for a full list and descriptions of all metadata.
- See Content types
recommendation-more-help
authoring-guide-help-main-guide