Collections

A collection is a container for one set of documentation: a help center, an API reference, an internal wiki or a blog. Each collection has its own pages, settings, theme, domain and publishing options.

#

Collection types

You pick a type when you create a collection.

Type Use it for
Doc Product docs, help articles, internal wikis and knowledge bases. This is the default.
API API documentation with endpoints you can send requests to. See Document an API.
Blogs Articles listed by date, with categories and an RSS feed. See Blogs.
Embed Content you embed inside your own product. See Embed the Editor.

Not sure which one fits? See Choose a Docs Type.

#

Create a collection

  1. In the top-left of the sidebar, click the collection switcher (it shows the current collection's name).
  2. Click Add collection. If your workspace has no collections yet, click Add Collection in the sidebar instead.
  3. In Create New Collection, enter a Collection Name (up to 50 characters).
  4. Check the Collection Slug. DocStar fills it in from the name. It can contain lowercase letters, numbers, hyphens and underscores (2 to 50 characters).
  5. Under Select Type, choose Doc, API, Blogs or Embed.
  6. Click Create Collection.

The collection slug can never be changed after you create the collection. AI assistants (MCP) and the DocStar CLI use it to identify your collection, so we recommend your company or product name.

To bring in existing content instead, choose Import collection from the same menu. See Import Content.

#

Switch between collections

Click the collection switcher and pick a collection from the list. Type in Search collections to filter a long list. Each entry shows its type and, where relevant, your access level (read only, read and write, or no access).

#

Collection settings

Open a collection, then click Settings in the sidebar. The Collection Actions tab holds the everyday management options:

Action What it does
Rename Collection Changes the display name. Type a new name and click Save.
Update Description Adds or edits a short description of the collection.
Import Pages Brings Markdown or MDX files into this collection.
Move Collection Moves the collection to another workspace you belong to. Choose the workspace and click Move.
Export Collection Downloads the collection as a JSON file.
Delete Collection Moves the collection to Archived Collections. Click Delete, then Delete again to confirm.

Other tabs in Settings cover publishing, theme, domain, header and footer, redirections, webhooks, MCP and more. They are explained in their own sections, for example Publish Pages and Logo and Theme.

#

Export formats

  • Doc and Blogs collections export straight to DocStar format.
  • API collections ask you to choose DocStar or Open API. Choose DocStar for a full backup. Open API produces a standard OpenAPI file, but your versions and endpoint descriptions are left out.
#

Delete and restore a collection

Deleting a collection removes it and all its pages from your workspace and your published site. It is not gone right away: you can restore it from Archived Collections in the collection switcher. See Archive, Trash and Restore.

#

Tips

  • Options are greyed out when you only have read access to a collection. Ask a workspace admin for write access.
  • Use separate collections for content with different audiences or domains, such as a public help center and an internal wiki.
Built with DocStar