Create a guide for a specific version of a documentation project
doc_name
string
required
Unique project name or the uuid
Example:
my-project
doc_version
union
required
Variant 1
string (uuid)
OR
Variant 2
integer
object
content
string
required
is_parent
boolean
required
nav_label
string
required
the label that shows on the navbar for this guide
slug
string
required
the url slug (route) for this guide. Must be one word. Use - for spaces. optimize the name for SEO
icon
string
lucide icon name for guide, see https://lucide.dev/icons/ for complete list of options
Example:
house
next_id
string (uuid)
parent_id
string (uuid)
prev_id
string (uuid)
table_of_contents
boolean
Responses
Guide created
application/json
object
created_at
string (date-time)
required
default_next_href
object
required
nullable
default_prev_href
object
required
nullable
icon
string
required
nullable
lucide icon name for guide, see https://lucide.dev/icons/ for complete list of options
Example:
house
id
string (uuid)
required
is_parent
boolean
required
nav_label
string
required
the label that shows on the navbar for this guide
next_href
object
required
nullable
order
integer
required
parent_id
string (uuid)
required
nullable
prev_href
object
required
nullable
slug
string
required
the url slug (route) for this guide. Must be one word. Use - for spaces. optimize the name for SEO
table_of_contents
boolean
required
Code Examples
Response