Design your docs with an agent

Ask an AI agent to build your Docs Portal for you. You describe what you want in plain words, and the agent creates the portal, sets the look, writes the pages, imports your API reference and arranges the sidebar. You review a preview, and the agent publishes when you approve. First connect your agent as described in Sign in as yourself.

What you can ask forlink

Theme colours. A primary, secondary and accent colour, and light, dark or follow the visitor's system.
Look. The typeface, the colours of code blocks, the style of the method badges in the API reference, and how wide the whole site can grow.
Logo text and footer. The text next to your logo, a one-line or a fuller footer with a column of links for each section, and whether the Powered by line shows.
Layout. A sidebar, a row of section menus across the top, or section tabs across the top with the sidebar for the current tab. Turn the sidebar, table of contents, breadcrumbs, page titles, previous and next links, footer and API reference on or off.
Top links. The links across the top of the site, to a page, an address or an email.
Landing page. Title, subtitle, a button, and blocks of headings, text, callouts, checklists and code samples.
Pages. Written in markdown (tables, task lists, note and warning alerts, code blocks, images by address) or built from blocks (heading, text, callout, checklist, code sample, API endpoint). Each page can carry its own search description and its own layout overrides.
Navigation. Sections and the order of pages inside them, including nested groups.
API reference. Import an OpenAPI, Swagger or Postman document by pasting it or giving its address.
Endpoint notes and code samples. Add a note to one endpoint, choose the languages of its generated code samples, set environments and switch the playground on.
Custom domain. Add a subdomain such as docs.example.com. The agent gives you the CNAME record to create at your DNS provider.

For the logo and favicon, give the agent an image file and it uploads it for you, or give it a public https address.

An example brieflink

Paste something like this into your agent:

Create a public Docs Portal called Acme API. Use teal as the main colour,
dark mode, and the logo text "Acme". Hide the table of contents.
Top links: Guides, API Reference and Support (mailto:help@acme.com).
Import the OpenAPI document at https://acme.com/openapi.json. Write a
Getting started page with a table of the three plans, and an Authentication
page with a warning callout and a curl example. Put them in a sidebar
section called Start here, before the API section. Show me a preview.

Preview, then publishlink

The agent gives you a preview link that points to your dashboard. Open it while you are signed in to NewInstance as a member allowed to preview the portal. The link carries no password or token, so it does nothing for anyone else. The design and the pages wait for a publish: the theme, branding, layout, landing page, navigation and pages reach the public site only when the agent publishes. The agent gives you the preview link first and publishes when you approve or ask it to. On a portal that is already published, it tells you before it publishes that the change goes live, and a few other changes show at once, as described under Changes run immediately, as you. When it has published, it tells you the live address.

What the public site does not show yetlink

The block types image, video, API playground, table, tabs and accordion are refused, so the agent uses markdown instead, which can show tables, images and code. Raw HTML in markdown is not shown. API endpoint blocks work on pages but not on the landing page. A good agent tells you when something you asked for falls in this list.

Changes run immediately, as youlink

The agent works as you. Each change is made the moment the agent asks for it and is recorded in your audit log. On a portal that is already published, a few changes show on the live site at once without a new publish: endpoint edits, imports, the logo, the favicon, and the portal name, description and visibility. Keep your agent app's confirmation prompts switched on while it works.

Write your API reference with the docs skilllink

If you import a Postman collection or an OpenAPI file, have your agent write it with the Docs Portal collection skill. The skill maps every part of the file onto the site: folders become pages, saved examples become response tabs and auth becomes an Authentication page. It also ships a checker the agent runs before importing. Install it in Claude Code:

curl -fsSL --create-dirs --output-dir ~/.claude/skills/docs-portal-collection-style -o SKILL.md https://service.newinstance.cloud/mcp/skills/docs-portal-collection-style/SKILL.md -o scripts/check_collection.py https://service.newinstance.cloud/mcp/skills/docs-portal-collection-style/scripts/check_collection.py -o assets/example-collection.json https://service.newinstance.cloud/mcp/skills/docs-portal-collection-style/assets/example-collection.json

Other agents can read the same instructions at https://service.newinstance.cloud/mcp/skills/docs-portal-collection-style/SKILL.md. Then ask your agent, for example: "Use the docs-portal-collection-style skill to write a Postman collection for our API and import it into our Docs Portal."

See Sign in as yourself for connecting an agent and for what an agent cannot do. For your Docs Portal that means it cannot see the portal as a visitor: no visitor views and no API playground. It can create preview tokens and open draft previews only when you turn on key access.