Stand Up A New Version With Starter Docs
A 3-step recipe with ReadMe. We can help you get access.
Recipe · 3 steps
Stand Up A New Version With Starter Docs
with ReadMe · Developer Portal Management
Create a new branch, a category on it, and a starter guide in the category.
- Create a new branch (version) to hold the starter documentation.
- Create a guide-type category on the newly created branch.
- Create a starter guide assigned to the new category.
What you'll need to have ready
- branchName: The name of the new branch (version) to create (e.g. "v2.1").
- categoryTitle: The display title for the starter category.
- guideTitle: The display title for the starter guide page.
- guideBody: The Markdown body content for the starter guide.
- apiKey: ReadMe API key used as a Bearer token.
For your developer
Arazzo workflow readme:create-branch-with-guide, 3 operations: {$sourceDescriptions.branchesApi.url}#/paths/~1branches/post → {$sourceDescriptions.categoriesApi.url}#/paths/~1branches~1{branch}~1categories/post → {$sourceDescriptions.guidesApi.url}#/paths/~1branches~1{branch}~1guides/post. Specs on APIs.io.