Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

How to make simple edits

To make simple edits, like fixing typos or adding text, all you need is a web browser and a GitHub account with sufficient privileges to the repository that you wish to edit.

Prerequisites

  • A personal or work GitHub account
  • A web browser, connected to the internet

GitHub

If you do not have a GitHub account, you can create one for free.

Once you have created a GitHub account, you can open the Hornbill-Docs home page and see the Hornbill Docs GitHub account.

You can then follow the instructions below to make and submit edits for consideration.

Using GitHub online only

Minor edits are easy using GitHub and its basic editing and Markdown preview capabilities. To make an edit to an existing document, follow these steps:

  1. Log into your GitHub account.
  2. Go to the Hornbill-Docs page.
  3. Click on the Repositories tab, then find and click on the document you want to edit. • TIP: If you’re already reading an article on Hornbill’s docs site and want to make an edit, just click the pencil icon in the top right corner. This takes you straight to the page on GitHub, whether you’re logged in to your GitHub account or not.
  4. At the top right of the page, click Fork. Accept the defaults, then click Create fork. This creates a copy of the HDocBook source code on your account. GitHub automatically navigates you to the home page of the newly forked repo.
  5. Browse the files in the repository and click on an .md file you want to edit. You can also edit the hdocbook.json file to add to or reorganize the navigation tree of the book.
  6. Click the pencil icon (Edit this file), and make your edits to the Markdown text.
  7. Each time you complete your edits on a file, you will be asked to commit the changes and provide a message that will be attached to the commit. This message will be seen by our reviewer when your changes are sent to us, and should be a brief description of what was done. See here for more information about commit messages. Remember: you are only committing changes to your fork, not to the main repository.
  8. Once you have finished your edits, create a pull request. Select the “Pull Requests” tab, and in that view, click the New Pull Request.
  9. Review the changes and make sure you are happy with them, then click Create Pull Request.
  10. Confirm by clicking Create Pull Request once more.

Important

You will notice that the Markdown content can be previewed in GitHub. While the content is rendered, GitHub only supports the basic CommonMark specification, so features such as this info panel will not appear correctly there. Hornbill Docs uses a different specification of Markdown which will render the features correctly.

That’s it — your pull requests have been submitted to the Hornbill Docs team who will review and accept/reject your changes in due course.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document