Keep your Starport docs current
After you migrate to Starport, Promptless keeps your content current as your product changes. It runs the same loop it runs on any docs repository. A product change triggers Promptless, which drafts the documentation update and opens a pull request for your team to review.
Use cases
Section titled “Use cases”| What happens | What Promptless does |
|---|---|
| An engineer merges a pull request that changes how a feature behaves. | Promptless drafts the matching documentation update and opens it as a pull request against your Starport repository. |
| A support conversation shows that a page is wrong or missing. | Promptless drafts the fix from that conversation for your team to review. |
| A documented procedure stops working. | The template’s weekly Doc Detective run opens a GitHub issue that mentions Promptless, and Promptless proposes a fix. This needs the Promptless GitHub App on your docs repository. |
How Promptless keeps your content current
Section titled “How Promptless keeps your content current”Promptless watches the sources your team already uses, such as merged pull requests and support conversations. When one of them signals a product change, Promptless drafts the documentation update and opens it as a pull request against your repository.
Your Starport content is Markdown and MDX in a Git repository, so Promptless edits it the way a teammate would. It creates a branch, changes files, and opens a reviewable change.
You review each suggestion before it publishes, and you approve it, request edits, or decline it. To ask Promptless about a suggestion or a change you need, message it in Slack or Microsoft Teams.
Related resources
Section titled “Related resources”The loop on your Starport site is the same one Promptless runs across every doc collection. A trigger activates on an event, Promptless gathers context and produces a suggestion, and it opens a pull request for review.
- How Promptless works, for the full model.
- Triggers, for the events that start the loop.