Designing the Home Page

Each user guide has a home page. For these home pages, we want to find the right balance between consistency and flexibility across solutions.

Required components

  • Title.
  • Brief description of the user guide or solution.
  • One or more sections of links to key articles and resources.

Optional components

Different user guides have different needs, so we don’t want to be too prescriptive about the content or formatting of your home page. You have flexibility in what you include in your home page and how you format it. You can use tables, image cards, bullet lists, or other methods.

If you want to add a banner image, see Banners below for details.

See the Home Page Template for ideas and syntax examples.


Banners help make home pages more inviting to users and avoids the “wall of text” design problem.

The landing page and the individual guides have banners that tie together the landing page and guides.

We hope to add banners to all the user guides of the core solutions. We’re working on getting a design resource to help us with banner templates and image assets. More details to follow.


If you create your own banner that has English text, make sure that you include the .ai or .psd file in your Git assets folder. The source file helps localizers.

Sample home page

See the Home page template for examples.

Landing pages

Some solutions have multiple user guides. You have the option of creating a landing page for these user guides.

We use the landing-pages.en repo to determine the appearance of landing pages on

The markdown files in these landing pages have their own syntax requirements. See the readme file in that repo if you want details.

If you want to make changes to these landing pages, submit a pull request, log a JIRA issue, or contact Bob.

On this page