Create A Category With A Guide
A 3-step recipe with ReadMe. We can help you get access.
Recipe · 3 steps
Create A Category With A Guide
with ReadMe · Developer Portal Management
Create a category then create a guide inside it and verify the guide.
- Create a guide-type sidebar category on the target branch to group the new guide under.
- Create a guide page on the same branch assigned to the category just created.
- Read the created guide back by slug to confirm it was published.
What you'll need to have ready
- branch: The branch (version) to create content on (e.g. "stable").
- categoryTitle: The display title for the new category.
- guideTitle: The display title for the new guide page.
- guideBody: The Markdown body content for the guide.
- apiKey: ReadMe API key used as a Bearer token.
For your developer
Arazzo workflow readme:create-category-with-guide, 3 operations: {$sourceDescriptions.categoriesApi.url}#/paths/~1branches~1{branch}~1categories/post → {$sourceDescriptions.guidesApi.url}#/paths/~1branches~1{branch}~1guides/post → {$sourceDescriptions.guidesApi.url}#/paths/~1branches~1{branch}~1guides~1{slug}/get. Specs on APIs.io.