Skip to content
DocuBot documentation

Sandbox and playground

You can use DocuBot to experiment with different documentation styles, audiences, and document types without affecting your live production help center. By creating a separate test site, you can preview how the AI interprets your code and adjust your settings before finalizing your public documentation.

Create a test documentation site

Establish a separate environment for experimentation that does not use your primary product slug.

  1. Navigate to your DocuBot dashboard.
  2. Click the Create documentation site button.
  3. Enter a unique, temporary name in the URL Slug field (for example, product-name-test). This ensures your sandbox remains separate from your intended production URL.

Connect a sample repository source

Provide the documentation engine with code context to generate your preview pages.

  1. In the Repository sources section, enter the GitHub repository URL you want to test.
  2. If the repository is private, ensure you have connected your GitHub account in your profile settings.
  3. The system validates the repository and prepares for the initial sync.

Apply different documentation styles

Compare how different styles change the tone and structure of your content.

  1. Scroll to the General style section.
  2. Select a style card, such as Precision Technical for exact, structured data or Approachable Guided for a warmer, plain-spoken tone.
  3. Notice how the style summary descriptions highlight the different focus areas for each ruleset.

Trigger a manual sync for preview

Generate the documentation immediately to see the results of your style and audience choices.

  1. Save your repository settings to return to the dashboard.
  2. Locate your test repository card and click the Rebuild documentation button.
  3. Monitor the Syncing now progress bar to see the status of each document type.
  4. Once the sync is complete, click the View docs link to open your generated sandbox site in a new tab.

Review and delete the test site

Verify the output at the temporary URL and remove the sandbox once your testing is complete.

  1. Browse through the generated pages to ensure the tone and document types meet your requirements.
  2. If you need to make changes, return to the repository settings and repeat the sync process.
  3. When you are finished experimenting, click Edit settings on the repository card.
  4. Open the Advanced account settings at the bottom of the page and follow the prompts to delete the test site. This permanently removes the documentation and its associated storage from your workspace.

Support and assistance

If you have questions about setting up a sandbox environment or need help with style presets, contact the support team: