How Starport works

Starport’s managed model decides who runs what and what your team owns. For the configuration you set yourself, see Configure your Starport site. For the migration to Starport, see Migrate to Starport.

Starport is a docs-as-code framework Promptless sets up and maintains on your behalf. In the docs-as-code model, your pages live as source files in a Git repository your team owns, versioned and reviewed like code. Promptless sets up the docs-as-code tooling around it: the site framework, the build and deploy pipeline, and the maintenance that keeps content current. Promptless also helps you set up hosting with a provider you choose.

The managed model end to end

Promptless sets up the build and deploy pipeline, which then runs in CI, and keeps your content current, so your team writes and reviews content. You keep ownership of your hosting account.

1. Promptless stands up your site on the Starport template, built on Astro Starlight.

2. Your builds and deploys run in CI, which Promptless sets up, so a merged change publishes through the hosting provider without manual steps.

3. Your site deploys to a hosting provider you choose, such as Vercel, on an account you own. Promptless helps you set that up and keeps the site’s supporting features current, including search, redirects, and the agent-ready surfaces.

4. Promptless detects when your product changes and opens documentation pull requests against your repository for your team to review.

Note

Promptless proposes every content change as a reviewable pull request. Your team approves and merges each one, so you stay in control of what publishes.

What you own

Your content lives in a Git repository your team owns and controls. Starport follows the docs-as-code model: your pages are source files in that repository. Promptless proposes edits the way a teammate would, by branching, changing files, and opening a pull request you review.

Because the repository is yours, you keep full history, access control, and the ability to edit content directly at any time. For the fundamentals of the docs-as-code model and why Promptless builds on it, see Understand docs-as-code.

After onboarding, you tune the site yourself through its configuration files. See Configure your Starport site for the options you control, and Keep your Starport docs current for how Promptless maintains content over time.

Prerequisites

To run on Starport, your documentation needs a docs-as-code footing:

• A Git repository your team owns, which holds your content as source files.
• Content in a format Starport builds from, authored in Markdown or MDX.

If your docs still live in a hosted editor that stores content in a proprietary database, the move to docs-as-code comes first. Migrate to Starport covers the managed migration, and Promptless handles that move for you.