StoneCreek Docs

KNOWLEDGE BASE

StoneCreek Docs

Find answers, setup guides, and step-by-step help.

StoneCreek Docs›Use the documentation portal shortcode

Use the documentation portal shortcode

Place a documentation library on any page, or show the documentation for one product with a shortcode.

Use the documentation portal shortcode to add StoneCreek Docs to a page. You can either show the full documentation library, which lists every published product, or display the documentation for a single product.

Choose the view you want

  • Documentation library: shows cards for all products that have published documentation.
  • Product documentation: shows the documentation for one specific product.

Insert the shortcode

  1. Open the page or post where you want the documentation to appear.
  2. Insert the shortcode for the view you want.
  3. Save or update the page.

Show the full documentation library

Use [stonecreek_docs] to display the documentation library.

Show one product’s documentation

Use [stonecreek_docs project="product-slug"] to display a single product’s documentation.

Replace product-slug with the slug for the documentation product you want to show.

What the shortcode displays

When used without a product, the shortcode displays the documentation library. When used with a product slug, it displays that product’s published documentation and opens the product home view for the reader.

Tips

  • If you want readers to find all of your published documentation in one place, use the library shortcode.
  • If you want a dedicated help page for one product, use the product shortcode for that documentation set.
  • After you publish new articles, the portal can present them as part of the product’s documentation set.

Related task

If you are organizing the portal itself, review the documentation order so the sidebar and Previous/Next navigation follow the sequence you want readers to use.

Powered by StoneCreek Docs