How do I add a document?

• Head over to the Manage tab and add a new Help Document.
• Include the title and content for the document.
• If you want to add a separate description for the document so you can reference what it is for, add it the Description section.
• The "Location" box is where you specify where you want the document to show up.
• Site Location includes all pages that are in your admin menu:
  • Main Documentation Page: > Documentation
  • Admin Bar Menu: Added to your top admin bar if enabled in Settings
  • Dashboard: Adds a meta box to your WordPress dashboard
  • Post/Page Edit Screen: The screen where you edit posts, pages, and other custom post types
  • Post/Page Admin List Screen: The screen that lists all of your posts, pages, and other custom post types
  • Other items from your menu...
• If you cannot find a menu item in the Site Location dropdown, then it is probably a custom post type; therefore, try selecting one of the Post/Page screens to see if it shows up in the list of post types.
• Publish the document and look for it in the location you set. That's it! :)

Why isn't my document showing up?

• When adding or updating a document, make sure the "Location" box is filled out correctly. By default, the site location is set to "None" so that you don't accidentally post something you didn't mean to. Furthermore, if you are using Post/Page screens, be sure you are using the setting the correct post type(s); these can be confusing sometimes.
• Note: it is recommended to test adding a document to common locations to ensure that you're setting everything correctly.

How do I use the same documentation across multiple sites?

• On the site that has the document you want to share, edit the document and set "Allow Public" to "Yes". Alternatively, you may allow all of your documents to be public by default from Settings.
• On the site in which you want to display the document, go to the Imports tab, add a new import, and enter the site URL of the site the document is coming from. Then update the import.
• You may then choose to automatically feed all of the documents that are public from the other site, or you can feed specific documents only. You also have the option to import it locally so you don't have to feed it remotely.

How do I add documents to the admin bar menu?

• First, enable the admin bar menu quick link from Settings.
• From the document edit screen, choose "Admin Bar Menu" from the Site Location dropdown, and then save it. That's it!
• The submenu item will display as "Document Title — Document Content" with all html tags stripped out.
• If you just want to link the menu item to a page, paste only the URL in the content box without anything else.

The Gutenberg editor doesn't allow the contextual help tab to be shown; can I still add help docs?

• Yes, if you choose contextual help from the Page Location dropdown, a "Help" button will appear at the top right of the Gutenberg editor.

How do I change the order of the documents on the main documentation page?

• You can do so by dragging the menu items in the left column up or down.

How do I add documents to folders on the main documentation page?

• Edit a document.
• Navigate to the "Folder" meta box.
• Add a new folder if one doesn't exist.
• Select the folder you want to put it in.
• You may also manage folders by clicking on the Folders tab.
• You may also drag and drop documents into different folders from the main documentation page.
• Import feeds cannot be added to folders since they cannot be assigned taxonomies. You must clone them onto your site to add them to folders.

If I delete a folder with documents, will I lose all of the documents inside the folder?

• No. Deleting a folder simply removes the documents from the folder and places them outside of the folder area on the main documentation page. If you want to delete all of the documents inside a folder, the easiest way to do so is to go to the Manage tab, filter by folder, delete all of documents in that folder, then delete the folder from the Folders tab.

How do I display a shortcode without executing it?

• You can use the [dont_do_shortcode content=''] shortcode for that.
• Important: make sure you use single-quotes in this shortcode so you can add double-quotes to the content value.
• Usage: [dont_do_shortcode content='{shortcode_name param="value" param2="value2"}Content{/shortcode_name}']
• Basically, replace the brackets with curly brackets and add the whole thing to the content parameter.
• Disable click-to-copy functionality with click_to_copy='false' parameter.
• You may use the optional code='false' parameter.

How do I add custom CSS to documents?

• You can use the [helpdocs_css] shortcode.
• Adding a stylesheet: [helpdocs_css stylesheet="/example.css" version="1"]
• If you are adding a stylesheet, the version parameter is optional. If left out, it will default to current time, which is good for testing. It is recommended to set a version when done so it can cache.
• Embedding styles directly: [helpdocs_css].example { background: red; }[/helpdocs_css]
• If you are embedding styles, it should be added to the top of the document above what you are styling.
• You cannot add a stylesheet and embed styles directly in the same shortcode.
• Custom CSS only works on the main documentation page.