Skip to content
DocuBot documentation

Sandbox and playground

You can experiment with different documentation styles, audiences, and advanced inputs by creating a sandbox environment. This allows you to preview how DocuBot interprets your code before publishing to your primary production URL.

Create a test documentation project

Setting up a separate project ensures your live documentation remains unchanged while you test new configurations.

  1. Open your DocuBot dashboard and click Add repository.
  2. Enter a unique, temporary URL slug (for example, product-name-sandbox).
  3. Provide a display name that identifies this as a test environment.

Expected result: A new project exists in your workspace with its own independent settings and public URL.

Connect a sample repository

Link a repository to provide the AI with context for generation.

  1. Enter the GitHub repository URL you wish to test.
  2. If the repository is private, ensure you have connected your GitHub account in Settings.
  3. Select a specific branch if you want to test documentation for unreleased code.

Expected result: DocuBot links to the source code without affecting any existing production projects.

Experiment with documentation styles

DocuBot offers several general styles that change the tone and structure of your help center.

  1. Navigate to the General style section of your test project.
  2. Select a style, such as Precision Technical for developers or Approachable Guided for end users.
  3. Save your changes.

Expected result: The project is configured to use the selected voice and layout rules for all generated pages.

Test advanced doc inputs

Use advanced inputs to see how specific instructions influence the AI-generated content.

  1. Open the Advanced doc inputs section.
  2. Add specific scenarios to Scenario priorities (for example, “How to reset a forgotten password”).
  3. List common pitfalls in Known issues & workarounds.

Expected result: These inputs act as primary data points for the AI when it writes your how-to guides and troubleshooting articles.

Trigger a manual sync

Generate a preview of your documentation to verify your settings.

  1. Go to the Repositories list in your dashboard.
  2. Find your test project and click Rebuild documentation.
  3. Wait for the sync job to complete. You can monitor progress on the repository card.

Expected result: DocuBot generates and publishes a full documentation site to your sandbox slug.

Reset or delete the test project

Once you are satisfied with your configuration, you can remove the sandbox project.

  1. Open the Edit settings page for your test project.
  2. Scroll down to the Danger zone.
  3. Click Delete repository and type the slug to confirm.

Expected result: The test project, its public URL, and all generated test documents are permanently removed.

Support and limits

Please note that free accounts are limited to one active repository. To create a sandbox project on a free plan, you must first remove your existing project. Paid accounts support multiple repositories for simultaneous testing.

If you need assistance setting up your sandbox environment, contact our support team: