The Support forum allows users to interact with each other to answer questions and learn to use your API or documentation in new ways!
To ask a new question, click on the Ask a Question button. This requires the user to sign-in or sign-up for a ReadMe account.
Fill out the question form:
The Discussions section in your developer hub features a version of our Markdown editor, allowing anyone submitting questions to include links, code samples, checklists, etc.
Your new question shows up at the top of the selected category. Other users can then upvote a question, in the top left of the page or respond to the question, at the bottom of the page. Users can also vote from the forum page
Admins can mark a question as solved when a good response has been posted.
Questions that have been solved show with a Answered! box on the forum page.
Notifications
The Project Admins will get a notification on any new posts. You as the poster, will get a notification if anyone responds to your post. Anyone who responds to your post will get subsequent notifications on any new responses.
Updated about 2 months ago
\n\n2. Fill out the question form:\n\n\n\nThe Discussions section in your developer hub features a version of our Markdown editor, allowing anyone submitting questions to include links, code samples, checklists, etc.\n\n\n\n3. Your new question shows up at the top of the selected category. Other users can then *upvote* a question, in the top left of the page or *respond* to the question, at the bottom of the page. *Users can also vote from the forum page*\n\n\n\n4. Admins can mark a question as solved when a good response has been posted.\n\n\n\n5. Questions that have been solved show with a **Answered!** box on the forum page.\n\n\n\n# Notifications\n\nThe Project Admins will get a notification on any new posts. You as the poster, will get a notification if anyone responds to your post. Anyone who responds to your post will get subsequent notifications on any new responses.","excerpt":null,"link":{"url":null,"new_tab":false},"next":{"description":null,"pages":[]}},"metadata":{"description":null,"image":{"uri":null,"url":null},"keywords":null,"title":null},"parent":{"uri":"/branches/3.0/guides/community-building"},"privacy":{"view":"public"},"slug":"discussion-forums","state":"current","title":"Discussion Forums","type":"basic","href":{"dash":"https://dash.readme.com/project/developers/v3.0/docs/discussion-forums","hub":"https://docs.readme.com/main/docs/discussion-forums"},"links":{"project":"/projects/me"},"project":{"name":"ReadMe","subdomain":"developers","uri":"/projects/me"},"renderable":{"status":true},"updated_at":"2025-06-04T18:39:31.367Z","uri":"/branches/3.0/guides/discussion-forums"},"meta":{"baseUrl":"/main","description":"The Support forum allows users to interact with each other to answer questions and learn to use your API or documentation in new ways!\n\nTo ask a new question, click on the Ask a Question button. This requires the user to sign-in or sign-up for a ReadMe account.\n\n\n\nFill out the question form:\n\n\nThe D…","hidden":false,"image":[],"metaTitle":"Discussion Forums","robots":"index","slug":"discussion-forums","title":"Discussion Forums","type":"docs"},"rdmd":{"baseUrl":"/main","body":"The Support forum allows users to interact with each other to answer questions and learn to use your API or documentation in new ways!\n\n1. To ask a new question, click on the **Ask a Question** button. This requires the user to sign-in or sign-up for a ReadMe account.\n\n\n\n2. Fill out the question form:\n\n\n\nThe Discussions section in your developer hub features a version of our Markdown editor, allowing anyone submitting questions to include links, code samples, checklists, etc.\n\n\n\n3. Your new question shows up at the top of the selected category. Other users can then *upvote* a question, in the top left of the page or *respond* to the question, at the bottom of the page. *Users can also vote from the forum page*\n\n\n\n4. Admins can mark a question as solved when a good response has been posted.\n\n\n\n5. Questions that have been solved show with a **Answered!** box on the forum page.\n\n\n\n# Notifications\n\nThe Project Admins will get a notification on any new posts. You as the poster, will get a notification if anyone responds to your post. Anyone who responds to your post will get subsequent notifications on any new responses.","dehydrated":{"toc":"","body":"
The Support forum allows users to interact with each other to answer questions and learn to use your API or documentation in new ways!
\n\n
To ask a new question, click on the Ask a Question button. This requires the user to sign-in or sign-up for a ReadMe account.
\n\n\n\n
Fill out the question form:
\n\n\n
The Discussions section in your developer hub features a version of our Markdown editor, allowing anyone submitting questions to include links, code samples, checklists, etc.
\n\n\n
Your new question shows up at the top of the selected category. Other users can then upvote a question, in the top left of the page or respond to the question, at the bottom of the page. Users can also vote from the forum page
\n\n\n\n
Admins can mark a question as solved when a good response has been posted.
\n\n\n\n
Questions that have been solved show with a Answered! box on the forum page.
\n\n\n
Notifications
\n
The Project Admins will get a notification on any new posts. You as the poster, will get a notification if anyone responds to your post. Anyone who responds to your post will get subsequent notifications on any new responses.
","css":"/*! tailwindcss v4.1.6 | MIT License | https://tailwindcss.com */\n@layer properties;\n@layer theme, base, components, utilities;\n@layer utilities {\n .readme-tailwind .border {\n border-style: var(--tw-border-style);\n border-width: 1px;\n }\n}\n@property --tw-border-style {\n syntax: \"*\";\n inherits: false;\n initial-value: solid;\n}\n@layer properties {\n @supports ((-webkit-hyphens: none) and (not (margin-trim: inline))) or ((-moz-orient: inline) and (not (color:rgb(from red r g b)))) {\n .readme-tailwind *, .readme-tailwind ::before, .readme-tailwind ::after, .readme-tailwind ::backdrop {\n --tw-border-style: solid;\n }\n }\n}\n"},"mdx":true,"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"lazyImages":true,"normalize":true,"safeMode":false,"settings":{"position":false},"theme":"light","customBlocks":{},"resourceID":"/branches/3.0/guides/discussion-forums","resourceType":"page","components":{},"baseUrl":"/main","terms":[{"_id":"621044ddeed2f80083ac6d97","term":"Enterprise group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"621044f40a103000a83239db","term":"Enterprise group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6210456696b020001ae688e8","term":"Enterprise group Admin","definition":"An Enterprise group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise group, and access any related project via the project’s dashboard."},{"_id":"6210457691c8d40013dcbfd5","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"621045878fefbb00a4567123","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"621045cf9b3c01001a609907","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Some Projects."},{"_id":"621045db6d2803001a066199","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or the Enterprise Group dashboard."},{"_id":"621045f2ddd9a6007632ed4c","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"621045feb3162a0020eca3c8","term":"Some Projects","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Some Projects”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6215351976fb85003c868c8b","term":"dashboard","definition":"The dashboard or dash refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"621535251676400014e8f933","term":"hub","definition":"The hub is the end user-facing side of your project—where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"62153f32e7fa6c00264fdf08","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"variables":{"user":{},"defaults":[{"source":"security","type":"http","_id":"6391241e050251002a8e3d28","name":"apiKey","scheme":"basic","apiSetting":"5f7cee46dd6cb1037e316143"},{"source":"","type":"","_id":"649b525defea78003e22657d","name":"user","default":"API_KEY"},{"source":"","type":"","_id":"6352dfca576cb4000f2e14ef","name":"ReadMe","default":"Default Value"},{"source":"","type":"","_id":"63d2fc41cba521006b5197ea","name":"id","default":"README_API_KEY"},{"source":"","type":"","_id":"63efced04cc2e710b54258b1","name":"email","default":"user@example.com"},{"source":"security","type":"http","_id":"67c0a4147d2882001f56dfb6","name":"bearer","scheme":"bearer","apiSetting":"6793d83ac3512a0044428725"},{"source":"","type":"","_id":"649f33f4cae212001dcd4573","name":"dasdf","default":"aSD"}]}},"terms":[{"_id":"621044ddeed2f80083ac6d97","term":"Enterprise group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"621044f40a103000a83239db","term":"Enterprise group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6210456696b020001ae688e8","term":"Enterprise group Admin","definition":"An Enterprise group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise group, and access any related project via the project’s dashboard."},{"_id":"6210457691c8d40013dcbfd5","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"621045878fefbb00a4567123","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"621045cf9b3c01001a609907","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Some Projects."},{"_id":"621045db6d2803001a066199","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or the Enterprise Group dashboard."},{"_id":"621045f2ddd9a6007632ed4c","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"621045feb3162a0020eca3c8","term":"Some Projects","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Some Projects”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6215351976fb85003c868c8b","term":"dashboard","definition":"The dashboard or dash refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"621535251676400014e8f933","term":"hub","definition":"The hub is the end user-facing side of your project—where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"62153f32e7fa6c00264fdf08","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"variables":{"user":{},"defaults":[{"source":"security","type":"http","_id":"6391241e050251002a8e3d28","name":"apiKey","scheme":"basic","apiSetting":"5f7cee46dd6cb1037e316143"},{"source":"","type":"","_id":"649b525defea78003e22657d","name":"user","default":"API_KEY"},{"source":"","type":"","_id":"6352dfca576cb4000f2e14ef","name":"ReadMe","default":"Default Value"},{"source":"","type":"","_id":"63d2fc41cba521006b5197ea","name":"id","default":"README_API_KEY"},{"source":"","type":"","_id":"63efced04cc2e710b54258b1","name":"email","default":"user@example.com"},{"source":"security","type":"http","_id":"67c0a4147d2882001f56dfb6","name":"bearer","scheme":"bearer","apiSetting":"6793d83ac3512a0044428725"},{"source":"","type":"","_id":"649f33f4cae212001dcd4573","name":"dasdf","default":"aSD"}]}},"sidebar":[{"pages":[{"deprecated":false,"hidden":false,"icon":"fad fa-hand-wave","isBodyEmpty":false,"renderable":{"status":true},"slug":"about-readme","title":"Welcome to ReadMe","type":"basic","updatedAt":"2025-07-09T21:09:35.000Z","pages":[],"uri":"/branches/3.0/guides/about-readme","category":"/branches/3.0/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"icon":"fad fa-rocket-launch","isBodyEmpty":false,"renderable":{"status":true},"slug":"quickstart","title":"Quickstart","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/quickstart","category":"/branches/3.0/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"icon":"fad fa-box-open","isBodyEmpty":false,"renderable":{"status":true},"slug":"migration-moving-your-docs-to-their-new-home","title":"Migrating to ReadMe","type":"basic","updatedAt":"2025-06-27T16:44:20.000Z","pages":[],"uri":"/branches/3.0/guides/migration-moving-your-docs-to-their-new-home","category":"/branches/3.0/categories/guides/Getting Started","parent":null},{"deprecated":false,"hidden":false,"icon":"fad fa-briefcase","isBodyEmpty":true,"link_url":"https://docs.readme.com/ent/docs/intro-to-readme-enterprise","renderable":{"status":true},"slug":"enterprise-guides","title":"Enterprise Guides","type":"link","updatedAt":"2025-06-24T23:37:15.000Z","pages":[],"uri":"/branches/3.0/guides/enterprise-guides","category":"/branches/3.0/categories/guides/Getting Started","parent":null}],"title":"Getting Started","uri":"/branches/3.0/categories/guides/Getting Started"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"migration","title":"ReadMe Refactored Migration Guide","type":"basic","updatedAt":"2025-06-27T16:46:00.000Z","pages":[],"uri":"/branches/3.0/guides/migration","category":"/branches/3.0/categories/guides/ReadMe Refactored","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"migration-faq","title":"Migration FAQ","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/migration-faq","category":"/branches/3.0/categories/guides/ReadMe Refactored","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"upgrading-to-rdme10","title":"Upgrading your ReadMe CLI to rdme@10","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/upgrading-to-rdme10","category":"/branches/3.0/categories/guides/ReadMe Refactored","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"refactored-vs-legacy","title":"Identify Your ReadMe Version and Plan","type":"basic","updatedAt":"2025-07-01T02:56:10.000Z","pages":[],"uri":"/branches/3.0/guides/refactored-vs-legacy","category":"/branches/3.0/categories/guides/ReadMe Refactored","parent":null}],"title":"ReadMe Refactored","uri":"/branches/3.0/categories/guides/ReadMe Refactored"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"creating-a-project","title":"Creating a Project","type":"basic","updatedAt":"2025-06-30T19:58:18.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"project-settings","title":"Project Settings","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/project-settings","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/creating-a-project"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"your-dashboard-and-profile","title":"Your Dashboard and Profile","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/your-dashboard-and-profile","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/creating-a-project"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"quick-switcher","title":"Quick Switcher","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/quick-switcher","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/creating-a-project"}],"uri":"/branches/3.0/guides/creating-a-project","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"navigating-your-hub-1","title":"Navigating Your Hub","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"quick-nav-api-reference","title":"Quick Nav in the API Reference","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/quick-nav-api-reference","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/navigating-your-hub-1"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"search","title":"Search + Search API","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/search","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/navigating-your-hub-1"}],"uri":"/branches/3.0/guides/navigating-your-hub-1","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"setting-up-custom-domain","title":"Setting Custom Domain & SSL","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"allowing-iframes","title":"Allow iFrames","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/allowing-iframes","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/setting-up-custom-domain"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"having-problems-generating-ssl","title":"Having Problems Generating SSL?","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/having-problems-generating-ssl","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/setting-up-custom-domain"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"url-paths-in-readme","title":"URL Paths in ReadMe","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/url-paths-in-readme","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/setting-up-custom-domain"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"turn-off-cloudflare-proxy","title":"Turn Off Cloudflare Proxy","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/turn-off-cloudflare-proxy","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/setting-up-custom-domain"}],"uri":"/branches/3.0/guides/setting-up-custom-domain","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"system-configuration","title":"System Configuration","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"suggested-edits","title":"Suggested Edits","type":"basic","updatedAt":"2025-07-18T17:01:06.000Z","pages":[],"uri":"/branches/3.0/guides/suggested-edits","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/system-configuration"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"login-expiration","title":"Login Expiration","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/login-expiration","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/system-configuration"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"internal-documentation","title":"Internal Documentation","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/internal-documentation","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/system-configuration"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"error-pages","title":"Error Pages","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/error-pages","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/system-configuration"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"redirect-scenarios","title":"Redirect Scenarios","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/redirect-scenarios","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/system-configuration"}],"uri":"/branches/3.0/guides/system-configuration","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"openapi","title":"OpenAPI Support in ReadMe","type":"basic","updatedAt":"2025-06-26T18:16:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"openapi-categories-pages-subpages","title":"Categories, Pages, and Subpages","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/openapi-categories-pages-subpages","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/openapi"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"openapi-resyncing","title":"Re-syncing Your OpenAPI Document","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/openapi-resyncing","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/openapi"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"openapi-compatibility-chart","title":"OpenAPI Compatibility Chart","type":"basic","updatedAt":"2025-07-01T23:02:59.000Z","pages":[],"uri":"/branches/3.0/guides/openapi-compatibility-chart","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/openapi"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"openapi-extensions","title":"OpenAPI Extensions","type":"basic","updatedAt":"2025-07-01T23:02:59.000Z","pages":[],"uri":"/branches/3.0/guides/openapi-extensions","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":"/branches/3.0/guides/openapi"}],"uri":"/branches/3.0/guides/openapi","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"custom-login-page","title":"Custom Login Page","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/custom-login-page","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"ip-addresses","title":"ReadMe's Outbound IP Addresses","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/ip-addresses","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"user-data-options","title":"Sending Data to Your Documentation's Users","type":"basic","updatedAt":"2025-06-27T00:02:37.000Z","pages":[],"uri":"/branches/3.0/guides/user-data-options","category":"/branches/3.0/categories/guides/PROJECT SETUP","parent":null}],"title":"PROJECT SETUP","uri":"/branches/3.0/categories/guides/PROJECT SETUP"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"document-api-overview","title":"Getting Started with Documentation","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/document-api-overview","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"guides","title":"Guides","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"creating-and-managing-guides","title":"Creating and Managing Guides","type":"basic","updatedAt":"2025-07-11T16:16:30.000Z","pages":[],"uri":"/branches/3.0/guides/creating-and-managing-guides","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/guides"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"structuring-your-docs","title":"Structuring Your Documentation","type":"basic","updatedAt":"2025-07-09T16:38:50.000Z","pages":[],"uri":"/branches/3.0/guides/structuring-your-docs","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/guides"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"creating-mermaid-diagrams","title":"Creating Mermaid Diagrams","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/creating-mermaid-diagrams","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/guides"}],"uri":"/branches/3.0/guides/guides","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"api-reference","title":"API Reference","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"openapi-upload-and-management","title":"OpenAPI Upload and Management","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/openapi-upload-and-management","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/api-reference"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"building-apis-from-scratch-with-the-api-designer","title":"Building APIs from Scratch with the API Designer","type":"basic","updatedAt":"2025-06-27T21:55:46.000Z","pages":[],"uri":"/branches/3.0/guides/building-apis-from-scratch-with-the-api-designer","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/api-reference"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"graphql","title":"GraphQL API Reference (Limited Support)","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/graphql","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/api-reference"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"oauth-workflows-in-try-it","title":"OAuth Workflows in Try It!","type":"basic","updatedAt":"2025-07-02T18:45:10.000Z","pages":[],"uri":"/branches/3.0/guides/oauth-workflows-in-try-it","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/api-reference"}],"uri":"/branches/3.0/guides/api-reference","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"recipes","title":"Recipes","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"creating-recipes","title":"Creating a Recipe","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/creating-recipes","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/recipes"}],"uri":"/branches/3.0/guides/recipes","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"changelog","title":"Changelog","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/changelog","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"landing-page","title":"Landing Page","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/landing-page","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"custom-page","title":"Custom Pages","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/custom-page","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"new-editor-ui","title":"ReadMe’s New UI","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/new-editor-ui","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"mdx","title":"MDX (Markdown + JSX)","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"using-mdx","title":"Using MDX","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/using-mdx","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/mdx"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"building-custom-mdx-components","title":"Building Custom MDX Components","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/building-custom-mdx-components","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/mdx"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"rendering-errors-invalid-mdx","title":"Rendering Errors: Invalid MDX","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/rendering-errors-invalid-mdx","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":"/branches/3.0/guides/mdx"}],"uri":"/branches/3.0/guides/mdx","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"reusable-content","title":"Reusable Content","type":"basic","updatedAt":"2025-07-17T23:30:21.000Z","pages":[],"uri":"/branches/3.0/guides/reusable-content","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"versions","title":"Versioning","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/versions","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"branches","title":"Branches","type":"basic","updatedAt":"2025-07-18T16:39:53.000Z","pages":[],"uri":"/branches/3.0/guides/branches","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"readme-micro","title":"ReadMe Micro","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/readme-micro","category":"/branches/3.0/categories/guides/DOCUMENTing your API","parent":null}],"title":"DOCUMENTing your API","uri":"/branches/3.0/categories/guides/DOCUMENTing your API"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"bi-directional-sync","title":"Bi-Directional Sync","type":"basic","updatedAt":"2025-07-07T18:26:37.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"documentation-structure","title":"Documentation Structure","type":"basic","updatedAt":"2025-07-07T18:26:37.000Z","pages":[],"uri":"/branches/3.0/guides/documentation-structure","category":"/branches/3.0/categories/guides/Syncing Your Content","parent":"/branches/3.0/guides/bi-directional-sync"}],"uri":"/branches/3.0/guides/bi-directional-sync","category":"/branches/3.0/categories/guides/Syncing Your Content","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"rdme","title":"Syncing Docs via CLI / GitHub","type":"basic","updatedAt":"2025-07-10T00:18:49.000Z","pages":[],"uri":"/branches/3.0/guides/rdme","category":"/branches/3.0/categories/guides/Syncing Your Content","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"github-actions-docs-example","title":"GitHub Actions Example: Syncing Markdown","type":"basic","updatedAt":"2025-07-08T21:34:24.000Z","pages":[],"uri":"/branches/3.0/guides/github-actions-docs-example","category":"/branches/3.0/categories/guides/Syncing Your Content","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"github-actions-openapi-example","title":"GitHub Actions Example: Syncing OpenAPI","type":"basic","updatedAt":"2025-07-08T21:34:24.000Z","pages":[],"uri":"/branches/3.0/guides/github-actions-openapi-example","category":"/branches/3.0/categories/guides/Syncing Your Content","parent":null}],"title":"Syncing Your Content","uri":"/branches/3.0/categories/guides/Syncing Your Content"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"owlbot","title":"Owlbot AI","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/owlbot","category":"/branches/3.0/categories/guides/AI FEATURES","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"LLMstxt","title":"LLMs.txt","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/LLMstxt","category":"/branches/3.0/categories/guides/AI FEATURES","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"AskAI","title":"Ask AI Dropdown","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/AskAI","category":"/branches/3.0/categories/guides/AI FEATURES","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"mcp-servers","title":"MCP","type":"basic","updatedAt":"2025-07-07T15:22:08.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"mcp-use-cases-for-technical-writers","title":"MCP Use Cases for Technical Writers","type":"basic","updatedAt":"2025-07-02T19:03:59.000Z","pages":[],"uri":"/branches/3.0/guides/mcp-use-cases-for-technical-writers","category":"/branches/3.0/categories/guides/AI FEATURES","parent":"/branches/3.0/guides/mcp-servers"}],"uri":"/branches/3.0/guides/mcp-servers","category":"/branches/3.0/categories/guides/AI FEATURES","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"aiagent","title":"AI Agent","type":"basic","updatedAt":"2025-07-16T00:14:38.000Z","pages":[],"uri":"/branches/3.0/guides/aiagent","category":"/branches/3.0/categories/guides/AI FEATURES","parent":null}],"title":"AI FEATURES","uri":"/branches/3.0/categories/guides/AI FEATURES"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"developer-dashboard","title":"Developer Dashboard Overview","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"my-developers","title":"My Developers Overview","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/my-developers","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/developer-dashboard"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"personalized-docs","title":"Personalized API Docs Overview","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"personalized-docs-webhook","title":"Set Up Personalized Docs","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/personalized-docs-webhook","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/personalized-docs"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"amazon-api-gateway-webhook","title":"Using Amazon API Gateway with the Personalized Docs Webhook","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/amazon-api-gateway-webhook","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/personalized-docs"}],"uri":"/branches/3.0/guides/personalized-docs","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/developer-dashboard"}],"uri":"/branches/3.0/guides/developer-dashboard","category":"/branches/3.0/categories/guides/Developer Experience","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"api-exploration-tools","title":"API Exploration Tools","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"sending-api-logs","title":"Real-Time API Logs Overview","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/sending-api-logs","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/api-exploration-tools"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"reference-core-pages","title":"API Reference Landing Pages","type":"basic","updatedAt":"2025-07-02T18:43:54.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"my-requests","title":"My Requests Overview","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/my-requests","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/reference-core-pages"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"showing-api-logs-to-users","title":"Show API Request History To Users","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/showing-api-logs-to-users","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/reference-core-pages"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"sdks","title":"SDKs","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/sdks","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/reference-core-pages"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"other-ways-to-use-api-metrics","title":"Other Ways to Send API Requests","type":"basic","updatedAt":"2025-07-02T18:51:00.000Z","pages":[],"uri":"/branches/3.0/guides/other-ways-to-use-api-metrics","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/reference-core-pages"}],"uri":"/branches/3.0/guides/reference-core-pages","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/api-exploration-tools"}],"uri":"/branches/3.0/guides/api-exploration-tools","category":"/branches/3.0/categories/guides/Developer Experience","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"using-metrics-charts","title":"API & Docs Metrics Charts","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"exporting-metrics-data","title":"Export Metrics Data","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/exporting-metrics-data","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/using-metrics-charts"}],"uri":"/branches/3.0/guides/using-metrics-charts","category":"/branches/3.0/categories/guides/Developer Experience","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"community-building","title":"Community Building","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"discussion-forums","title":"Discussion Forums","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"managing-forum-support","title":"Managing Forum Support","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/managing-forum-support","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/discussion-forums"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"creating-a-dev-faq","title":"Creating a Dev FAQ","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/creating-a-dev-faq","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/discussion-forums"}],"uri":"/branches/3.0/guides/discussion-forums","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/community-building"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"health-check-status-updates","title":"Health Check Status Updates","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/health-check-status-updates","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/community-building"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"supporting-your-developers","title":"Supporting Your Developers","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/supporting-your-developers","category":"/branches/3.0/categories/guides/Developer Experience","parent":"/branches/3.0/guides/community-building"}],"uri":"/branches/3.0/guides/community-building","category":"/branches/3.0/categories/guides/Developer Experience","parent":null}],"title":"Developer Experience","uri":"/branches/3.0/categories/guides/Developer Experience"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"design-themes","title":"Themes","type":"basic","updatedAt":"2025-06-28T17:52:02.000Z","pages":[],"uri":"/branches/3.0/guides/design-themes","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"custom-css-and-javascript","title":"Custom CSS and JavaScript","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"customizing-docs-using-css-variables","title":"Customizing Docs Using CSS Variables","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/customizing-docs-using-css-variables","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/custom-css-and-javascript"}],"uri":"/branches/3.0/guides/custom-css-and-javascript","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"custom-icons","title":"Custom Icons","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/custom-icons","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"custom-css-with-dark-mode","title":"Dark Mode: Overview & Custom CSS","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/custom-css-with-dark-mode","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"site-navigation","title":"Site Navigation","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"subheader-layout","title":"Subheader Layout","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/subheader-layout","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/site-navigation"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"site-footer","title":"Site Footer","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/site-footer","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/site-navigation"}],"uri":"/branches/3.0/guides/site-navigation","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"pro-tips","title":"Pro Tips","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/pro-tips","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"integrations","title":"Integrations","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"slack","title":"Slack","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/slack","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"google-analytics","title":"Google Analytics","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/google-analytics","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"segment","title":"Segment","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/segment","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"zendesk","title":"Zendesk","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/zendesk","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"localize","title":"Localize","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/localize","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"transifex","title":"Transifex","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/transifex","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"typekit-key","title":"Typekit","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/typekit-key","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"google-site-verification","title":"Google Site Verification","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/google-site-verification","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"recaptcha","title":"reCaptcha","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/recaptcha","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"aws","title":"Amazon API Gateway","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/aws","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"stainless","title":"Stainless","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/stainless","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":"/branches/3.0/guides/integrations"}],"uri":"/branches/3.0/guides/integrations","category":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION","parent":null}],"title":"PROJECT CUSTOMIZATION","uri":"/branches/3.0/categories/guides/PROJECT CUSTOMIZATION"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"your-account","title":"Your Account","type":"basic","updatedAt":"2025-07-11T00:56:29.000Z","pages":[],"uri":"/branches/3.0/guides/your-account","category":"/branches/3.0/categories/guides/ADMINISTRATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"two-factor-authentication","title":"Two-Factor Authentication","type":"basic","updatedAt":"2025-07-11T00:56:29.000Z","pages":[],"uri":"/branches/3.0/guides/two-factor-authentication","category":"/branches/3.0/categories/guides/ADMINISTRATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"manage-team","title":"Teammates and Roles","type":"basic","updatedAt":"2025-07-18T16:35:08.000Z","pages":[],"uri":"/branches/3.0/guides/manage-team","category":"/branches/3.0/categories/guides/ADMINISTRATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"plans-and-pricing","title":"Plans and Pricing","type":"basic","updatedAt":"2025-07-18T16:39:53.000Z","pages":[],"uri":"/branches/3.0/guides/plans-and-pricing","category":"/branches/3.0/categories/guides/ADMINISTRATION","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"payment-and-billing-info","title":"Payment and Billing Info","type":"basic","updatedAt":"2025-07-11T00:56:29.000Z","pages":[],"uri":"/branches/3.0/guides/payment-and-billing-info","category":"/branches/3.0/categories/guides/ADMINISTRATION","parent":null}],"title":"ADMINISTRATION","uri":"/branches/3.0/categories/guides/ADMINISTRATION"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"need-more-support","title":"Need More Support?","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/need-more-support","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"link_url":"http://readmestatus.com","link_external":true,"renderable":{"status":true},"slug":"readme-status","title":"ReadMe Status","type":"link","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/readme-status","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"feature-requests","title":"Feature Requests","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/feature-requests","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"security-faq","title":"Security FAQ","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"bug-bounty-program","title":"Bug Bounty Program","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/bug-bounty-program","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":"/branches/3.0/guides/security-faq"}],"uri":"/branches/3.0/guides/security-faq","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"technical-faq","title":"Technical FAQ","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/technical-faq","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"vpat","title":"Accessibility Conformance Report","type":"basic","updatedAt":"2025-06-24T00:04:23.000Z","pages":[],"uri":"/branches/3.0/guides/vpat","category":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS","parent":null}],"title":"TECHNICAL SUPPORT & QUESTIONS","uri":"/branches/3.0/categories/guides/TECHNICAL SUPPORT & QUESTIONS"}],"branches":{"total":6,"page":1,"per_page":100,"paging":{"next":null,"previous":null,"first":"/developers/api-next/v2/branches?prefix=v3.0&page=1&per_page=100","last":null},"data":[{"base":{"base":null,"display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"href":{"external":{"diff":null,"view":null}},"name":"3.0_move-rdme","updated_at":"2025-06-25T15:41:51.095Z","uri":"/branches/3.0_move-rdme"},{"base":{"base":null,"display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"href":{"external":{"diff":null,"view":null}},"name":"3.0_add_speakeasy_docs","updated_at":"2025-06-24T22:10:46.104Z","uri":"/branches/3.0_add_speakeasy_docs"},{"base":{"base":null,"display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"href":{"external":{"diff":null,"view":null}},"name":"3.0_rename-apis","updated_at":"2025-07-01T20:49:37.487Z","uri":"/branches/3.0_rename-apis"},{"base":{"base":null,"display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"href":{"external":{"diff":null,"view":null}},"name":"3.0_editor-qa-test","updated_at":"2025-07-15T17:57:22.303Z","uri":"/branches/3.0_editor-qa-test"},{"base":{"base":null,"display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"href":{"external":{"diff":null,"view":null}},"name":"3.0_add-editor-role","updated_at":"2025-07-18T17:37:17.974Z","uri":"/branches/3.0_add-editor-role"},{"base":{"base":null,"display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"href":{"external":{"diff":null,"view":null}},"name":"3.0_reorg-creating-a-project","updated_at":"2025-07-18T22:28:36.887Z","uri":"/branches/3.0_reorg-creating-a-project"}],"type":"branch"},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"liveblocks":{"copilotId":"co_11Q0l0JJlkcBhhAYUFh8s"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.422.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"621044ddeed2f80083ac6d97","term":"Enterprise group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"621044f40a103000a83239db","term":"Enterprise group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6210456696b020001ae688e8","term":"Enterprise group Admin","definition":"An Enterprise group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise group, and access any related project via the project’s dashboard."},{"_id":"6210457691c8d40013dcbfd5","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"621045878fefbb00a4567123","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"621045cf9b3c01001a609907","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Some Projects."},{"_id":"621045db6d2803001a066199","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or the Enterprise Group dashboard."},{"_id":"621045f2ddd9a6007632ed4c","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"621045feb3162a0020eca3c8","term":"Some Projects","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Some Projects”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6215351976fb85003c868c8b","term":"dashboard","definition":"The dashboard or dash refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"621535251676400014e8f933","term":"hub","definition":"The hub is the end user-facing side of your project—where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"62153f32e7fa6c00264fdf08","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"variables":{"user":{},"defaults":[{"source":"security","type":"http","_id":"6391241e050251002a8e3d28","name":"apiKey","scheme":"basic","apiSetting":"5f7cee46dd6cb1037e316143"},{"source":"","type":"","_id":"649b525defea78003e22657d","name":"user","default":"API_KEY"},{"source":"","type":"","_id":"6352dfca576cb4000f2e14ef","name":"ReadMe","default":"Default Value"},{"source":"","type":"","_id":"63d2fc41cba521006b5197ea","name":"id","default":"README_API_KEY"},{"source":"","type":"","_id":"63efced04cc2e710b54258b1","name":"email","default":"user@example.com"},{"source":"security","type":"http","_id":"67c0a4147d2882001f56dfb6","name":"bearer","scheme":"bearer","apiSetting":"6793d83ac3512a0044428725"},{"source":"","type":"","_id":"649f33f4cae212001dcd4573","name":"dasdf","default":"aSD"}]},"project":{"_id":"5f7ce9e3a5504d0414d025d0","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":null,"markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"all-docs"},"colors":{"highlight":"","main":"#018EF5","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"scriptalert2script","tk_body":"scriptalert3script"},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl","linkStyle":"tabs"},"body":{"style":"overlap"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"row","link_logo_to_url":true,"theme":"line","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":true,"logo":["https://files.readme.io/cad5441be73105b537fc281d974e5e183158da735ea4502567c4544bd1db1589-logo_light.svg","cad5441be73105b537fc281d974e5e183158da735ea4502567c4544bd1db1589-logo_light.svg",null,null,"#018ef5",null,"685dd8f1a937400018078851"],"logo_white":["https://files.readme.io/3230046a081b5585dda1f4fb336a1ed3f182d4f677000a7343a5f6e81fb0414e-logo_dark.svg","3230046a081b5585dda1f4fb336a1ed3f182d4f677000a7343a5f6e81fb0414e-logo_dark.svg",null,null,"#000000",null,"685dd8f46f4ed500741941a3"],"logo_white_use":true,"favicon":[],"stylesheet":"/** Collapsing sidebars, CSS; added by ReadMe.io **/\n\n.theme-solid .sidebar-nav ul li a {\n padding-left: 10px;\n}\n.section-left .sidebar-nav h4:hover {\n cursor: pointer;\n color: #111; \n}\n\n.header h1.navbar-brand {\n width: 150px !important;\n}\n\n.header .searchbox.focus input {\n width: 180px;\n}\n\n\n/* Homepage */\n.support { \n position: relative;\n height: 288px;\n padding: 25px 40px 20px 70px;\n}\n\n.page-home #header {\n \t\tmargin-bottom: 25px;\n}\n\n.support img {\n width: 1070px;\n position: absolute;\n left: 0;\n top: 0; \n}\nheader .support h2 {\n\t\tdisplay: none;\n}\n\nheader .support p {\n color: #fff;\n margin: 53px 0 25px;\n line-height: 1.6em;\n \tfont-weight: 500;\n font-size: 17px;\n color: rgba(255,255,255,0.8);\n}\nheader .support p strong {\n color: #fff;\n}\n\n.theme-solid header .support a.btn {\n background: #fff;\n color: #1c84cc;\n font-weight: bold;\n box-shadow: 0 2px 2px rgba(0,0,0,0.1); \n font-size: 13px;\n text-transform: uppercase;\n font-weight: 700;\n transition: 0.15s ease-out;\n \tpadding: 6px 20px 10px;\n}\n.theme-solid header .support a.btn:hover {\n box-shadow: 0 2px 2px rgba(0,0,0,0.3);\n}\n.theme-solid header .support a.btn:active {\n box-shadow: 0 0;\n \tposition: relative;\n top: 1px;\n}\n.theme-solid header .support a .fa {\n display: inline-block;\n text-align: left;\n color: #1c84cc;\n transition: 0.15s ease-out;\n width: 0px;\n overflow: hidden;\n opacity: 0;\n top: 4px;\n position: relative;\n font-size: 18px;\n transform: scale(0.6);\n}\n.theme-solid header .support a.btn:hover .fa {\n width: 28px;\n opacity: 1;\n transform: scale(1);\n}\n\nh1.navbar-brand {\n\tmargin-left: 16px !important;\n}\n.header .nav.navbar-nav.pull-right {\n right: -9px;\n}\n.container.body-container {\n\tpadding-left: 0;\n padding-right: 0;\n}","stylesheet_hub2":"[data-color-mode=\"dark\"] {\n\t--color-bg-page: var(--gray0);\n}\n\n@media (prefers-color-scheme: dark) {\n\t[data-color-mode=\"system\"] {\n\t\t--color-bg-page: var(--gray0);\n\t}\n}\n\n.Spinner_overlay {\n\tbackground: var(--color-bg-page);\n}\n.rm-Changelog .markdown-body p:first-of-type {\n font-size: 1.25em;\n margin: 30px 0;\n}\n\n.rm-Changelog .markdown-body h2 + p {\n font-size: 1.25em;\n}\n\n.rm-Changelog .markdown-body h3 {\n margin-top: 30px;\n}\n\n.rm-Changelog .badge {\n background: linear-gradient(160deg, rgba(0,0,0,0.25), rgba(89,75,159,0.75) 10%) black;\n box-shadow: inset 0 0 0 1px var(--color-border-default);\n border-radius: 1em;\n color: white;\n display: inline-block;\n filter: brightness(1.15) saturate(2.5);\n font-size: 10px;\n font-family: var(--font-family);\n line-height: 1;\n overflow: hidden;\n padding: 0.35em 0.65em;\n position: relative;\n text-decoration: none !important;\n transition: filter var(--transition-slow) var(--transition-timing); \n top: 0.3em;\n\n &:hover,\n &:active,\n &:focus {\n color: white;\n filter: brightness(1.4) saturate(2.5);\n text-decoration: none !important;\n }\n}\n\n[data-color-mode=\"system\"] .rm-Changelog .badge {\n @media (prefers-color-scheme: dark) {\n filter: brightness(1.15) saturate(1.75);\n }\n}\n\n[data-color-mode=\"dark\"] .rm-Changelog .badge {\n filter: brightness(1.15) saturate(1.75);\n}\n\n@media print {\n .rm-Header,\n .rm-Sidebar,\n .rm-Header-bottom,\n .rm-Header-top,\n .rm-Header-top .rm-Header-left,\n .rm-Header-top .rm-Header-right,\n .rm-PageThumbs,\n .rm-Pagination,\n .UpdatedAt,\n .NextStepsDivider,\n .suggestEdits,\n .heading-anchor-icon,\n .intercom-lightweight-app-launcher,\n .reference-flyout {\n display: none !important;\n }\n \n .rm-Article {\n\t max-width: none !important;\n }\n \n .content-body {\n width: auto !important;\n }\n \n .rm-ReferenceMain > .Flex_row {\n\t align-items: center !important;\n\t flex-direction: column !important;\n }\n \n .rm-Playground {\n\t box-shadow: none !important;\n\t max-width: none;\n }\n}","javascript":"/* Collapsing sidebars, JavaScript; added by ReadMe.io */\n\n$('.sidebar-nav ul').each(function() {\n var $active = $('li.active', $(this));\n if(!$active.length) {\n $(this).hide();\n }\n});\n\n$('.sidebar-nav h4').click(function() {\n $(this).next('ul').slideToggle();\n});\n\n$('.sidebar-nav').find('a.active').closest('ul').css('display','block'); // optional, keeps the active documentation page's parent category expanded","javascript_hub2":"","html_promo":"
ReadMe Documentation
Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!
Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!
","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"What's Next","promos":[{"extras":{"type":"html","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"The ReadMe Developer Hub","text":"","_id":"542334961972e21d7dae4e01"}],"sidebarStyle":"ellipses","showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"system","changelog":{"layoutExpanded":true,"showAuthor":false,"showExactDate":true},"allowApiExplorerJsonEditor":false,"ai_dropdown":"enabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","copilot":"enabled","perplexity":"disabled"},"showPageIcons":true,"layout":{"full_width":true,"style":"compact"}},"custom_domain":"","childrenProjects":[],"derivedPlan":"enterprise","description":"Beautiful documentation made easy.","isExternalSnippetActive":false,"error404":"404","experiments":["64cd2000e0b0c1b1fa55712d"],"first_page":"docs","flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newEditor":true,"oldMarkdown":false,"newMarkdownBetaProgram":false,"newApiExplorer":true,"disableAnonForum":true,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":true,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":true,"myDevelopers":true,"superHub":true,"developerDashboard":true,"allowReusableOTPs":false,"dashHomeRefresh":true,"owlbotAi":true,"apiV2":true,"git":{"read":false,"write":false},"superHubBeta":true,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":true,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":true,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://developers.readme.io/","git":{"migration":{"createRepository":{"start":"2025-02-27T20:30:21.672Z","end":"2025-02-27T20:30:22.051Z","status":"successful"},"transformation":{"end":"2025-02-27T20:30:25.564Z","start":"2025-02-27T20:30:22.422Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:30:26.543Z","start":"2025-02-27T20:30:25.602Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T21:07:41.687Z","status":"successful","end":"2025-02-27T21:07:41.688Z"}},"sync":{"linked_repository":{"_id":"67edb6060cad5a00184ac252","provider_type":"github","id":"959498828","name":"docs-developers","url":"https://github.com/readmeio/docs-developers","privacy":{"private":true,"visibility":"internal"},"linked_at":"2025-04-02T22:11:18.862Z","linked_by":"5e8b72d0e5e76b003dc97d7b","connection":"67edb600238377004599f583","full_name":"readmeio/docs-developers","error":{}},"installationRequest":{},"connections":[{"_id":"67edb600238377004599f583","active":true,"created_at":"2024-10-29T09:52:43.000Z","created_by":"5e8b72d0e5e76b003dc97d7b","installation_id":56524903,"owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"provider_type":"github"}],"providers":[]}},"glossaryTerms":[{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"graphqlSchema":"https://test.com","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"settings":{"page":"nz3r09cr7dk1","status":false,"url":""},"provider":"statusPage"},"intercom_secure_emailonly":false,"intercom":"m6855w1q","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"pageType":"Documentation","alignment":"left","type":"docs"},{"type":"html","alignment":"left","html":""}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":50000000,"thumbsEnabled":true,"planLimit":20000000,"realtime":{"dashEnabled":true,"hubEnabled":true},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":true,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"name":"ReadMe","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":true,"metricsSDK":true},"owlbot":{"enabled":true,"isPaying":false,"lastIndexed":"2025-07-20T11:05:21.950Z","customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":true,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"enterprise","planOverride":"enterprise","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"enterprise","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":true,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":100,"totalScore":230},"reCaptchaSiteKey":"6LdHWIgcAAAAAEDbyrvc-xSVdHo2tRjrkamgjjof","reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"},"subdomain":"developers","subpath":"main","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Customer Stories","url":"https://readme.com/customers"},{"type":"url","text":"ReadMe Blog","url":"https://blog.readme.com"}],"right":[{"type":"user"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2020-10-20T22:04:19.564Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://readme.com","versions":[{"_id":"5f7ce9e3a5504d0414d0243f","codename":"Hub 2 (Pre-Docs Migration)","createdAt":"2016-05-09T19:20:09.413Z","is_deprecated":true,"project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":51,"is_beta":false,"is_hidden":true,"is_stable":false,"version":"2.0-archive","version_clean":"2.0.0-archive","categories":["5f7ce9e3a5504d0414d024bf","5f7ce9e3a5504d0414d024c0","5f7ce9e3a5504d0414d024c1","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","5f7ce9e3a5504d0414d024c2","5f7ce9e3a5504d0414d024c3","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","5f7ce9e3a5504d0414d024c4","5f7ce9e3a5504d0414d024c5","5730e2e9053a062b00cf475d","5f7ce9e3a5504d0414d024c6","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","5f7ce9e3a5504d0414d024c8","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","5f7ce9e3a5504d0414d024c9","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","5f7ce9e3a5504d0414d024e8","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","5f7ceacf43621b0311080a59","5f7cee46dd6cb1037e316144","5f7cefc76b6e5e04c3a4c74c","5f7cf1a9cb79be02e1a588c9","5f88bd664649f900680641fb","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","60189781b18d9a0012221411","61084e16a18107003124ef8f","61e1ef1e337b90003a9e11a5","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","62743670700ba00042a2b1ce","62b38d3d7447ac00937a7e04","62e2da409b967b0014077fe7","62ec4ff01f323202a13f419c","62ec516e5ad03d02680c2d9f","6320f56b35e026000f45ad58","636e6642417174009d9b563d"],"pdfStatus":"complete","updatedAt":"2025-06-30T15:39:53.492Z","apiRegistries":[{"name":"api-endpoints","url":"1yl2ql5lb604m"},{"name":"developer-metrics-api","url":"45ns416lbeakwq8"}],"source":"readme"},{"_id":"5f7ce9e3a5504d0414d0243e","version":"1.0-legacy","codename":"Hub 1","hasDoc":true,"__v":28,"is_beta":false,"is_stable":false,"project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2014-09-24T21:16:06.446Z","version_clean":"1.0.0-legacy","categories":["5f7ce9e3a5504d0414d0246a","5f7ce9e3a5504d0414d0246b","54dbf493cb6515210029556f","55dbb7ecb035900d0063fc9f","5f7ce9e3a5504d0414d0246c","5f7ce9e3a5504d0414d0246d","5f7ce9e3a5504d0414d0246e","5f7ce9e3a5504d0414d0246f","5f7ce9e3a5504d0414d02470","5f7ce9e3a5504d0414d02471","5f7ce9e3a5504d0414d02472","5f7ce9e3a5504d0414d02473","5f7ce9e3a5504d0414d02474","5f7ce9e3a5504d0414d02475","5f7ce9e3a5504d0414d02476","5f7ce9e3a5504d0414d02477","56eb18818e83410e000238d4","57206b8e5be73c17009601f3","57218435e1805f0e0042201d","5721845eecb38d0e00d80e0a","5f7ce9e3a5504d0414d024be","5a7c9d447dce000013d8b966","5bce1907c732630004f41da7","5cd20b75a35909003956cdb8","5cd20bcfa78471006231a32b","5d5b7b118fab3d00188e3cdf","5d5b7b2e99c1310020e150e9","5d5b7d8db0a1f80107d077d8","6376ba4d127d990003112b73"],"is_hidden":true,"createdAt":"2014-09-24T21:16:06.446Z","hasReference":false,"is_deprecated":true,"pdfStatus":"complete","updatedAt":"2025-05-06T17:24:27.899Z","apiRegistries":[{"name":"api-settings","url":"1mld74kq6wbkn5"}],"source":"readme"},{"_id":"62056dee230e07007218bf4c","version":"2.0","version_clean":"2.0.0","codename":"product-guides","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","62056dee230e07007218be06","62056dee230e07007218be07","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","62056dee230e07007218be09","5730e2e9053a062b00cf475d","62056dee230e07007218be0a","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","62056dee230e07007218be0e","62056dee230e07007218be0f","62056dee230e07007218be10","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","62292aea889520008ed0113b","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","624cb20585a75d004c978f57","624e2238df4eb60013286917","633470b833bb8d04e657051a","6376ba4d127d990003112b72","63e43d347c3efc02c02c5986","6442d3485ae2d10e2654d2f3","64f8c3b94e8f64001f07ea58","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","6732850c3cee9b006fe502ba","6793d83ac3512a0044428727"],"createdAt":"2016-05-09T19:20:09.413Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":17,"pdfStatus":"complete","forked_from":"5f7ce9e3a5504d0414d0243f","updatedAt":"2025-05-08T19:17:44.501Z","apiRegistries":[{"filename":"readme-api.json","uuid":"h3xgn4hm8deioh8"},{"filename":"readme-api-v2-beta.json","uuid":"h3xgn11m8deir9k"}],"gitApiRegistries":{},"source":"readme"},{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"}],"variableDefaults":[{"source":"security","type":"http","_id":"6391241e050251002a8e3d28","name":"apiKey","scheme":"basic","apiSetting":"5f7cee46dd6cb1037e316143"},{"source":"","type":"","_id":"649b525defea78003e22657d","name":"user","default":"API_KEY"},{"source":"","type":"","_id":"6352dfca576cb4000f2e14ef","name":"ReadMe","default":"Default Value"},{"source":"","type":"","_id":"63d2fc41cba521006b5197ea","name":"id","default":"README_API_KEY"},{"source":"","type":"","_id":"63efced04cc2e710b54258b1","name":"email","default":"user@example.com"},{"source":"security","type":"http","_id":"67c0a4147d2882001f56dfb6","name":"bearer","scheme":"bearer","apiSetting":"6793d83ac3512a0044428725"}],"webhookEnabled":true},"custom_domain":"docs.readme.com","childrenProjects":[],"derivedPlan":"enterprise","description":"Beautiful documentation made easy.","isExternalSnippetActive":false,"error404":"404","experiments":["64cd2000e0b0c1b1fa55712d"],"first_page":"docs","flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"newEditor":true,"newEditorDash":true,"oldMarkdown":false,"newMarkdownBetaProgram":true,"useReactApp":true,"disableAnonForum":true,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"singleProjectEnterprise":false,"dashReact":true,"metricsV2":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":true,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":true,"disablePasswordlessLogin":false,"personalizedDocs":true,"myDevelopers":true,"superHub":true,"allowReusableOTPs":false,"developerDashboard":true,"dashHomeRefresh":true,"owlbotAi":true,"apiV2":true,"dashQuickstart":false,"git":{"read":false,"write":false},"superHubBeta":true,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":true,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":true,"childManagedBidi":true,"superHubBranches":true,"requiresJQuery":true,"externalSdkSnippets":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":true,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newApiExplorer":true,"tutorials":true,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"allowReferenceUpgrade":true},"fullBaseUrl":"https://docs.readme.com/main","git":{"migration":{"createRepository":{"start":"2025-02-27T20:30:21.672Z","end":"2025-02-27T20:30:22.051Z","status":"successful"},"transformation":{"end":"2025-02-27T20:30:25.564Z","start":"2025-02-27T20:30:22.422Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:30:26.543Z","start":"2025-02-27T20:30:25.602Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T21:07:41.687Z","status":"successful","end":"2025-02-27T21:07:41.688Z"}},"sync":{"linked_repository":{"_id":"67edb6060cad5a00184ac252","provider_type":"github","id":"959498828","name":"docs-developers","url":"https://github.com/readmeio/docs-developers","privacy":{"private":true,"visibility":"internal"},"linked_at":"2025-04-02T22:11:18.862Z","linked_by":"5e8b72d0e5e76b003dc97d7b","connection":"67edb600238377004599f583","full_name":"readmeio/docs-developers","error":{}},"installationRequest":{},"connections":[{"_id":"67edb600238377004599f583","active":true,"created_at":"2024-10-29T09:52:43.000Z","created_by":"5e8b72d0e5e76b003dc97d7b","installation_id":56524903,"owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"provider_type":"github"}],"providers":[]}},"glossaryTerms":[{"_id":"621044ddeed2f80083ac6d97","term":"Enterprise group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"621044f40a103000a83239db","term":"Enterprise group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6210456696b020001ae688e8","term":"Enterprise group Admin","definition":"An Enterprise group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise group, and access any related project via the project’s dashboard."},{"_id":"6210457691c8d40013dcbfd5","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"621045878fefbb00a4567123","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"621045cf9b3c01001a609907","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Some Projects."},{"_id":"621045db6d2803001a066199","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or the Enterprise Group dashboard."},{"_id":"621045f2ddd9a6007632ed4c","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"621045feb3162a0020eca3c8","term":"Some Projects","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Some Projects”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6215351976fb85003c868c8b","term":"dashboard","definition":"The dashboard or dash refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"621535251676400014e8f933","term":"hub","definition":"The hub is the end user-facing side of your project—where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"62153f32e7fa6c00264fdf08","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"graphqlSchema":"https://test.com","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"settings":{"page":"nz3r09cr7dk1","status":false,"url":""},"provider":"statusPage"},"intercom_secure_emailonly":false,"intercom":"m6855w1q","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"pageType":"Documentation","alignment":"left","type":"docs"},{"type":"html","alignment":"left","html":""}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":50000000,"thumbsEnabled":true,"planLimit":20000000,"realtime":{"dashEnabled":true,"hubEnabled":true},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":true,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"name":"ReadMe","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":true,"metricsSDK":true},"owlbot":{"enabled":true,"isPaying":false,"lastIndexed":"2025-07-20T11:05:21.950Z","customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":true,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"enterprise","planOverride":"business","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"enterprise","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":true,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":100,"totalScore":230},"reCaptchaSiteKey":"6LdHWIgcAAAAAEDbyrvc-xSVdHo2tRjrkamgjjof","reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"siblings":[{"_id":"5f7ce9e3a5504d0414d025d0","flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newEditor":true,"oldMarkdown":false,"newMarkdownBetaProgram":false,"newApiExplorer":true,"disableAnonForum":true,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":true,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":true,"myDevelopers":true,"superHub":true,"developerDashboard":true,"allowReusableOTPs":false,"dashHomeRefresh":true,"owlbotAi":true,"apiV2":true,"git":{"read":false,"write":false},"superHubBeta":true,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":true,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":true,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":true,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"name":"ReadMe","subdomain":"developers","description":"Beautiful documentation made easy.","robotsAllow":true,"is_active":true,"internal":"","stable":"679965bf6efdd80042a59378","owner":"5490112a5d87f80b00a035f8","subpath":"main","git":{"sync":{"connection":[],"github":[],"gitlab":[],"logs":[{"stage":"install","message":"Starting GitHub app installation","extras":{"installationId":56524903,"setupAction":"update","state":"5f7ce9e3a5504d0414d025d0-06e0e09a434005220afb","projectId":"5f7ce9e3a5504d0414d025d0","codeProvided":true},"status":"processing","timestamp":"2025-04-02T22:11:11.420Z"},{"stage":"install","message":"GitHub App installed successfully","extras":{"installationId":56524903,"setupAction":"update"},"status":"successful","timestamp":"2025-04-02T22:11:12.185Z"},{"stage":"connect","message":"Linked repository readmeio/docs-developers to project.","extras":{"repository":"readmeio/docs-developers","provider":"github","repositoryId":"959498828","connectedBy":"tony@readme.io"},"status":"successful","timestamp":"2025-04-02T22:11:18.908Z"}],"connections":[{"permissions":{"contents":"write","metadata":"read"},"events":["push","repository"],"_id":"67edb600238377004599f583","provider_type":"github","installation_id":56524903,"created_by":"5e8b72d0e5e76b003dc97d7b","created_at":"2024-10-29T09:52:43.000Z","owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"active":true,"updated_at":"2025-04-02T22:11:11.000Z"}],"providers":[],"linked_repository":{"_id":"67edb6060cad5a00184ac252","provider_type":"github","id":"959498828","name":"docs-developers","url":"https://github.com/readmeio/docs-developers","privacy":{"private":true,"visibility":"internal"},"linked_at":"2025-04-02T22:11:18.862Z","linked_by":"5e8b72d0e5e76b003dc97d7b","connection":"67edb600238377004599f583","full_name":"readmeio/docs-developers"},"installationRequest":{}},"migrationInitiatedBy":"marc@readme.io","revertReason":"search broke","migration":{"createRepository":{"start":"2025-02-27T20:30:21.672Z","end":"2025-02-27T20:30:22.051Z","status":"successful"},"transformation":{"end":"2025-02-27T20:30:25.564Z","start":"2025-02-27T20:30:22.422Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:30:26.543Z","start":"2025-02-27T20:30:25.602Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T21:07:41.687Z","status":"successful","end":"2025-02-27T21:07:41.688Z"}},"repositoryName":"developers-dbc88de6580a"},"mcp":{"state":"enabled"},"github_user":"","github_repo":"","github_color":"green_007200"},{"_id":"6205993d7fb8d70029bba49b","flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"newEditor":true,"newEditorDash":true,"oldMarkdown":false,"newMarkdownBetaProgram":false,"useReactApp":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"singleProjectEnterprise":false,"dashReact":false,"metricsV2":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":true,"superHub":true,"allowReusableOTPs":false,"owlbotAi":false,"apiV2":true,"git":{"read":false,"write":false},"superHubBeta":true,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":true,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"modules":{"landing":false,"docs":true,"examples":true,"reference":false,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false},"nav_names":{"docs":"Enterprise","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"name":"Enterprise","subpath":"ent","subdomain":"enterprise-docs","description":"Beautiful documentation made easy.","robotsAllow":true,"is_active":true,"internal":"","stable":"6205993d7fb8d70029bba049","owner":"5250b3ad5ac09b3564000005","git":{"sync":{"connection":[],"github":[],"gitlab":[],"logs":[],"connections":[],"providers":[],"setup":{"_id":"685d89974ae13d00716a4d18","provider_type":"github","verify_sync_hash":"ea78d9281dc3d184b1ac","setup_by":"justina@readme.io"},"installationRequest":{}},"migrationInitiatedBy":"ashley@readme.io","revertReason":"search","migration":{"createRepository":{"start":"2025-02-27T20:28:11.287Z","end":"2025-02-27T20:28:11.664Z","status":"successful"},"transformation":{"end":"2025-02-27T20:28:16.384Z","start":"2025-02-27T20:28:11.907Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:28:17.068Z","start":"2025-02-27T20:28:16.423Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T20:32:50.981Z","status":"successful","end":"2025-02-27T20:32:50.981Z"}},"repositoryName":"enterprise-docs-44295d32a665"},"mcp":{"state":"disabled"},"github_user":"","github_repo":"","github_color":"green_007200"},{"_id":"5d8907e71937f80012277b72","owner":"5250b3ad5ac09b3564000005","nav_names":{"discuss":"","changelog":"","reference":"","docs":"","tutorials":"","recipes":""},"modules":{"logs":false,"suggested_edits":true,"discuss":false,"changelog":false,"reference":false,"examples":true,"docs":true,"landing":false,"custompages":true,"tutorials":false,"graphql":false},"internal":"","is_active":true,"flags":{"translation":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"newApiExplorer":true,"newEditor":true,"hideGoogleAnalytics":false,"cookieAuthentication":false,"allowXFrame":false,"speedyRender":false,"correctnewlines":false,"swagger":false,"oauth":false,"migrationSwaggerRun":false,"migrationRun":false,"hub2":true,"enterprise":true,"allow_hub2":false,"newMarkdown":true,"alwaysShowDocPublishStatus":false,"newMarkdownBetaProgram":false,"newMarkdownLooseMode":false,"oldMarkdown":false,"newSearch":true,"rdmdCompatibilityMode":false,"tutorials":true,"staging":false,"useReactApp":true,"allowApiExplorerJsonEditor":false,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":true,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":true,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"robotsAllow":true,"description":"","subdomain":"rdmd","name":"ReadMe Markdown","stable":"5fdf7610134322007389a71b","subpath":"","git":{"sync":{"connection":[],"logs":[{"stage":"install","message":"Starting GitHub app installation","extras":{"installationId":56524903,"setupAction":"update","state":"5d8907e71937f80012277b72-7a7641afdf41e73646c9","projectId":"5d8907e71937f80012277b72","codeProvided":true},"status":"processing","timestamp":"2025-03-03T20:30:47.798Z"},{"stage":"install","message":"GitHub App installed successfully","extras":{"installationId":56524903,"setupAction":"update"},"status":"successful","timestamp":"2025-03-03T20:30:48.265Z"},{"stage":"connect","message":"Connected repository readmeio/rdmd-docs to project.","extras":{"repository":"readmeio/rdmd-docs","provider":"github","repositoryId":"942256316","connectedBy":"marc@readme.io"},"status":"successful","timestamp":"2025-03-03T20:31:08.234Z"}],"verifySyncHash":"7a7641afdf41e73646c9","connections":[{"_id":"67c611782c2069006e497eb2","provider_type":"github","installation_id":56524903,"created_at":"2024-10-29T09:52:43.000Z","owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"active":true,"updated_at":"2025-03-06T18:49:45.000Z","events":["push","repository"],"permissions":{"contents":"write","metadata":"read"}}],"linked_repository":{"id":"942256316","name":"rdmd-docs","url":"https://github.com/readmeio/rdmd-docs","provider_type":"github","privacy":{"visibility":"internal","private":true},"linked_at":"2025-03-03T20:31:07.334Z","linked_by":"55f1d0205fe76419007dc7a9","connection":"67c611782c2069006e497eb2","full_name":"readmeio/rdmd-docs","_id":"68704c2ba6771fb1d1d0e46c"},"github":[],"providers":[],"installationRequest":{}},"migrationInitiatedBy":"ashley@readme.io","revertReason":"search broke","migration":{"createRepository":{"start":"2025-02-27T20:27:50.497Z","end":"2025-02-27T20:27:50.881Z","status":"successful"},"transformation":{"end":"2025-02-27T20:27:57.489Z","start":"2025-02-27T20:27:51.217Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:27:58.264Z","start":"2025-02-27T20:27:57.554Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T20:35:43.962Z","status":"successful","end":"2025-02-27T20:35:43.963Z"}},"repositoryName":"rdmd-a6ebbaa647e4"},"mcp":{"state":"disabled"},"github_user":"","github_repo":"","github_color":"green_007200"}],"stable":{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"},"subdomain":"developers","subpath":"main","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Customer Stories","url":"https://readme.com/customers"},{"type":"url","text":"ReadMe Blog","url":"https://blog.readme.com"}],"right":[{"type":"user","text":"User"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2020-10-20T22:04:19.564Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://readme.com","versions":[{"_id":"5f7ce9e3a5504d0414d0243e","version":"1.0-legacy","codename":"Hub 1","hasDoc":true,"__v":28,"is_beta":false,"is_stable":false,"project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2014-09-24T21:16:06.446Z","version_clean":"1.0.0-legacy","categories":["5f7ce9e3a5504d0414d0246a","5f7ce9e3a5504d0414d0246b","54dbf493cb6515210029556f","55dbb7ecb035900d0063fc9f","5f7ce9e3a5504d0414d0246c","5f7ce9e3a5504d0414d0246d","5f7ce9e3a5504d0414d0246e","5f7ce9e3a5504d0414d0246f","5f7ce9e3a5504d0414d02470","5f7ce9e3a5504d0414d02471","5f7ce9e3a5504d0414d02472","5f7ce9e3a5504d0414d02473","5f7ce9e3a5504d0414d02474","5f7ce9e3a5504d0414d02475","5f7ce9e3a5504d0414d02476","5f7ce9e3a5504d0414d02477","56eb18818e83410e000238d4","57206b8e5be73c17009601f3","57218435e1805f0e0042201d","5721845eecb38d0e00d80e0a","5f7ce9e3a5504d0414d024be","5a7c9d447dce000013d8b966","5bce1907c732630004f41da7","5cd20b75a35909003956cdb8","5cd20bcfa78471006231a32b","5d5b7b118fab3d00188e3cdf","5d5b7b2e99c1310020e150e9","5d5b7d8db0a1f80107d077d8","6376ba4d127d990003112b73"],"is_hidden":true,"createdAt":"2014-09-24T21:16:06.446Z","hasReference":false,"is_deprecated":true,"pdfStatus":"complete","updatedAt":"2025-05-06T17:24:27.899Z","apiRegistries":[{"name":"api-settings","url":"1mld74kq6wbkn5"}],"source":"readme"},{"_id":"5f7ce9e3a5504d0414d0243f","codename":"Hub 2 (Pre-Docs Migration)","createdAt":"2016-05-09T19:20:09.413Z","is_deprecated":true,"project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":51,"is_beta":false,"is_hidden":true,"is_stable":false,"version":"2.0-archive","version_clean":"2.0.0-archive","categories":["5f7ce9e3a5504d0414d024bf","5f7ce9e3a5504d0414d024c0","5f7ce9e3a5504d0414d024c1","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","5f7ce9e3a5504d0414d024c2","5f7ce9e3a5504d0414d024c3","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","5f7ce9e3a5504d0414d024c4","5f7ce9e3a5504d0414d024c5","5730e2e9053a062b00cf475d","5f7ce9e3a5504d0414d024c6","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","5f7ce9e3a5504d0414d024c8","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","5f7ce9e3a5504d0414d024c9","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","5f7ce9e3a5504d0414d024e8","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","5f7ceacf43621b0311080a59","5f7cee46dd6cb1037e316144","5f7cefc76b6e5e04c3a4c74c","5f7cf1a9cb79be02e1a588c9","5f88bd664649f900680641fb","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","60189781b18d9a0012221411","61084e16a18107003124ef8f","61e1ef1e337b90003a9e11a5","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","62743670700ba00042a2b1ce","62b38d3d7447ac00937a7e04","62e2da409b967b0014077fe7","62ec4ff01f323202a13f419c","62ec516e5ad03d02680c2d9f","6320f56b35e026000f45ad58","636e6642417174009d9b563d"],"pdfStatus":"complete","updatedAt":"2025-06-30T15:39:53.492Z","apiRegistries":[{"name":"api-endpoints","url":"1yl2ql5lb604m"},{"name":"developer-metrics-api","url":"45ns416lbeakwq8"}],"source":"readme"},{"_id":"62056dee230e07007218bf4c","version":"2.0","version_clean":"2.0.0","codename":"product-guides","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","62056dee230e07007218be06","62056dee230e07007218be07","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","62056dee230e07007218be09","5730e2e9053a062b00cf475d","62056dee230e07007218be0a","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","62056dee230e07007218be0e","62056dee230e07007218be0f","62056dee230e07007218be10","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","62292aea889520008ed0113b","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","624cb20585a75d004c978f57","624e2238df4eb60013286917","633470b833bb8d04e657051a","6376ba4d127d990003112b72","63e43d347c3efc02c02c5986","6442d3485ae2d10e2654d2f3","64f8c3b94e8f64001f07ea58","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","6732850c3cee9b006fe502ba","6793d83ac3512a0044428727"],"createdAt":"2016-05-09T19:20:09.413Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":17,"pdfStatus":"complete","forked_from":"5f7ce9e3a5504d0414d0243f","updatedAt":"2025-05-08T19:17:44.501Z","apiRegistries":[{"filename":"readme-api.json","uuid":"h3xgn4hm8deioh8"},{"filename":"readme-api-v2-beta.json","uuid":"h3xgn11m8deir9k"}],"gitApiRegistries":{},"source":"readme"},{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"}],"variableDefaults":[{"source":"","type":"","_id":"649f33f4cae212001dcd4573","name":"dasdf","default":"aSD"},{"source":"security","type":"http","_id":"6391241e050251002a8e3d28","name":"apiKey","scheme":"basic","apiSetting":"5f7cee46dd6cb1037e316143"},{"source":"","type":"","_id":"649b525defea78003e22657d","name":"user","default":"API_KEY"},{"source":"","type":"","_id":"6352dfca576cb4000f2e14ef","name":"ReadMe","default":"Default Value"},{"source":"","type":"","_id":"63d2fc41cba521006b5197ea","name":"id","default":"README_API_KEY"},{"source":"","type":"","_id":"63efced04cc2e710b54258b1","name":"email","default":"user@example.com"},{"source":"security","type":"http","_id":"67c0a4147d2882001f56dfb6","name":"bearer","scheme":"bearer","apiSetting":"6793d83ac3512a0044428725"}],"webhookEnabled":true,"parent":{"_id":"62059a520d12cc006cca892d","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#018EF5","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":"#018ef5"},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl","linkStyle":"buttons"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":"https://docs.readme.com/main/docs/about-readme"},"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/8993363f4203ff8216e66c3135a31cc3bcf94281875179daf29cbe749b2a295f-logo_light.svg","8993363f4203ff8216e66c3135a31cc3bcf94281875179daf29cbe749b2a295f-logo_light.svg",357,70,"#018ef5",null,"685dd8d4c52a5d00368227b1"],"logo_white":["https://files.readme.io/c549a59a8ee2ef96ac1b067f2ae4b2d5dd592a5170e10f128ce8b2f5025bcce6-logo_dark.svg","c549a59a8ee2ef96ac1b067f2ae4b2d5dd592a5170e10f128ce8b2f5025bcce6-logo_dark.svg",357,70,"#000000",null,"685dd8d7c52a5d00368227b2"],"logo_white_use":true,"favicon":[],"stylesheet":"","stylesheet_hub2":"[data-color-mode=\"dark\"] {\n\t--color-bg-page: var(--gray0);\n}\n\n@media (prefers-color-scheme: dark) {\n\t[data-color-mode=\"system\"] {\n\t\t--color-bg-page: var(--gray0);\n\t}\n}\n\n.Spinner_overlay {\n\tbackground: var(--color-bg-page);\n}","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[],"loginLogo":["https://files.readme.io/8275bff-readme-blue.svg","readme-blue.svg",null,null,"#000000"],"colorScheme":"system","logo_large":false,"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false,"ai_dropdown":"disabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","copilot":"enabled","perplexity":"enabled"},"showPageIcons":true,"layout":{"full_width":false,"style":"classic"}},"child":{"_id":"5f7ce9e3a5504d0414d025d0","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":null,"markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"all-docs"},"colors":{"highlight":"","main":"#018EF5","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"scriptalert2script","tk_body":"scriptalert3script"},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl","linkStyle":"tabs"},"body":{"style":"overlap"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"row","link_logo_to_url":true,"theme":"line","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":true,"logo":["https://files.readme.io/cad5441be73105b537fc281d974e5e183158da735ea4502567c4544bd1db1589-logo_light.svg","cad5441be73105b537fc281d974e5e183158da735ea4502567c4544bd1db1589-logo_light.svg",null,null,"#018ef5",null,"685dd8f1a937400018078851"],"logo_white":["https://files.readme.io/3230046a081b5585dda1f4fb336a1ed3f182d4f677000a7343a5f6e81fb0414e-logo_dark.svg","3230046a081b5585dda1f4fb336a1ed3f182d4f677000a7343a5f6e81fb0414e-logo_dark.svg",null,null,"#000000",null,"685dd8f46f4ed500741941a3"],"logo_white_use":true,"favicon":[],"stylesheet":"/** Collapsing sidebars, CSS; added by ReadMe.io **/\n\n.theme-solid .sidebar-nav ul li a {\n padding-left: 10px;\n}\n.section-left .sidebar-nav h4:hover {\n cursor: pointer;\n color: #111; \n}\n\n.header h1.navbar-brand {\n width: 150px !important;\n}\n\n.header .searchbox.focus input {\n width: 180px;\n}\n\n\n/* Homepage */\n.support { \n position: relative;\n height: 288px;\n padding: 25px 40px 20px 70px;\n}\n\n.page-home #header {\n \t\tmargin-bottom: 25px;\n}\n\n.support img {\n width: 1070px;\n position: absolute;\n left: 0;\n top: 0; \n}\nheader .support h2 {\n\t\tdisplay: none;\n}\n\nheader .support p {\n color: #fff;\n margin: 53px 0 25px;\n line-height: 1.6em;\n \tfont-weight: 500;\n font-size: 17px;\n color: rgba(255,255,255,0.8);\n}\nheader .support p strong {\n color: #fff;\n}\n\n.theme-solid header .support a.btn {\n background: #fff;\n color: #1c84cc;\n font-weight: bold;\n box-shadow: 0 2px 2px rgba(0,0,0,0.1); \n font-size: 13px;\n text-transform: uppercase;\n font-weight: 700;\n transition: 0.15s ease-out;\n \tpadding: 6px 20px 10px;\n}\n.theme-solid header .support a.btn:hover {\n box-shadow: 0 2px 2px rgba(0,0,0,0.3);\n}\n.theme-solid header .support a.btn:active {\n box-shadow: 0 0;\n \tposition: relative;\n top: 1px;\n}\n.theme-solid header .support a .fa {\n display: inline-block;\n text-align: left;\n color: #1c84cc;\n transition: 0.15s ease-out;\n width: 0px;\n overflow: hidden;\n opacity: 0;\n top: 4px;\n position: relative;\n font-size: 18px;\n transform: scale(0.6);\n}\n.theme-solid header .support a.btn:hover .fa {\n width: 28px;\n opacity: 1;\n transform: scale(1);\n}\n\nh1.navbar-brand {\n\tmargin-left: 16px !important;\n}\n.header .nav.navbar-nav.pull-right {\n right: -9px;\n}\n.container.body-container {\n\tpadding-left: 0;\n padding-right: 0;\n}","stylesheet_hub2":".rm-Changelog .markdown-body p:first-of-type {\n font-size: 1.25em;\n margin: 30px 0;\n}\n\n.rm-Changelog .markdown-body h2 + p {\n font-size: 1.25em;\n}\n\n.rm-Changelog .markdown-body h3 {\n margin-top: 30px;\n}\n\n.rm-Changelog .badge {\n background: linear-gradient(160deg, rgba(0,0,0,0.25), rgba(89,75,159,0.75) 10%) black;\n box-shadow: inset 0 0 0 1px var(--color-border-default);\n border-radius: 1em;\n color: white;\n display: inline-block;\n filter: brightness(1.15) saturate(2.5);\n font-size: 10px;\n font-family: var(--font-family);\n line-height: 1;\n overflow: hidden;\n padding: 0.35em 0.65em;\n position: relative;\n text-decoration: none !important;\n transition: filter var(--transition-slow) var(--transition-timing); \n top: 0.3em;\n\n &:hover,\n &:active,\n &:focus {\n color: white;\n filter: brightness(1.4) saturate(2.5);\n text-decoration: none !important;\n }\n}\n\n[data-color-mode=\"system\"] .rm-Changelog .badge {\n @media (prefers-color-scheme: dark) {\n filter: brightness(1.15) saturate(1.75);\n }\n}\n\n[data-color-mode=\"dark\"] .rm-Changelog .badge {\n filter: brightness(1.15) saturate(1.75);\n}\n\n@media print {\n .rm-Header,\n .rm-Sidebar,\n .rm-Header-bottom,\n .rm-Header-top,\n .rm-Header-top .rm-Header-left,\n .rm-Header-top .rm-Header-right,\n .rm-PageThumbs,\n .rm-Pagination,\n .UpdatedAt,\n .NextStepsDivider,\n .suggestEdits,\n .heading-anchor-icon,\n .intercom-lightweight-app-launcher,\n .reference-flyout {\n display: none !important;\n }\n \n .rm-Article {\n\t max-width: none !important;\n }\n \n .content-body {\n width: auto !important;\n }\n \n .rm-ReferenceMain > .Flex_row {\n\t align-items: center !important;\n\t flex-direction: column !important;\n }\n \n .rm-Playground {\n\t box-shadow: none !important;\n\t max-width: none;\n }\n}","javascript":"/* Collapsing sidebars, JavaScript; added by ReadMe.io */\n\n$('.sidebar-nav ul').each(function() {\n var $active = $('li.active', $(this));\n if(!$active.length) {\n $(this).hide();\n }\n});\n\n$('.sidebar-nav h4').click(function() {\n $(this).next('ul').slideToggle();\n});\n\n$('.sidebar-nav').find('a.active').closest('ul').css('display','block'); // optional, keeps the active documentation page's parent category expanded","javascript_hub2":"","html_promo":"
ReadMe Documentation
Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!
","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"What's Next","promos":[{"extras":{"type":"html","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"The ReadMe Developer Hub","text":"","_id":"542334961972e21d7dae4e01"}],"sidebarStyle":"ellipses","showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"system","changelog":{"layoutExpanded":true,"showAuthor":false,"showExactDate":true},"allowApiExplorerJsonEditor":false,"ai_dropdown":"enabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","copilot":"enabled","perplexity":"disabled"},"showPageIcons":true,"layout":{"full_width":true,"style":"compact"}},"custom_domain":"","childrenProjects":[],"derivedPlan":"enterprise","description":"Beautiful documentation made easy.","isExternalSnippetActive":false,"error404":"404","experiments":["64cd2000e0b0c1b1fa55712d"],"first_page":"docs","flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newEditor":true,"oldMarkdown":false,"newMarkdownBetaProgram":false,"newApiExplorer":true,"disableAnonForum":true,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":true,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":true,"myDevelopers":true,"superHub":true,"developerDashboard":true,"allowReusableOTPs":false,"dashHomeRefresh":true,"owlbotAi":true,"apiV2":true,"git":{"read":false,"write":false},"superHubBeta":true,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":true,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":true,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://developers.readme.io/","git":{"migration":{"createRepository":{"start":"2025-02-27T20:30:21.672Z","end":"2025-02-27T20:30:22.051Z","status":"successful"},"transformation":{"end":"2025-02-27T20:30:25.564Z","start":"2025-02-27T20:30:22.422Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:30:26.543Z","start":"2025-02-27T20:30:25.602Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T21:07:41.687Z","status":"successful","end":"2025-02-27T21:07:41.688Z"}},"sync":{"linked_repository":{"_id":"67edb6060cad5a00184ac252","provider_type":"github","id":"959498828","name":"docs-developers","url":"https://github.com/readmeio/docs-developers","privacy":{"private":true,"visibility":"internal"},"linked_at":"2025-04-02T22:11:18.862Z","linked_by":"5e8b72d0e5e76b003dc97d7b","connection":"67edb600238377004599f583","full_name":"readmeio/docs-developers","error":{}},"installationRequest":{},"connections":[{"_id":"67edb600238377004599f583","active":true,"created_at":"2024-10-29T09:52:43.000Z","created_by":"5e8b72d0e5e76b003dc97d7b","installation_id":56524903,"owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"provider_type":"github"}],"providers":[]}},"glossaryTerms":[{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"graphqlSchema":"https://test.com","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"settings":{"page":"nz3r09cr7dk1","status":false,"url":""},"provider":"statusPage"},"intercom_secure_emailonly":false,"intercom":"m6855w1q","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"pageType":"Documentation","alignment":"left","type":"docs"},{"type":"html","alignment":"left","html":""}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":50000000,"thumbsEnabled":true,"planLimit":20000000,"realtime":{"dashEnabled":true,"hubEnabled":true},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":true,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"name":"ReadMe","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":true,"metricsSDK":true},"owlbot":{"enabled":true,"isPaying":false,"lastIndexed":"2025-07-20T11:05:21.950Z","customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":true,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"enterprise","planOverride":"enterprise","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"enterprise","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":true,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":100,"totalScore":230},"reCaptchaSiteKey":"6LdHWIgcAAAAAEDbyrvc-xSVdHo2tRjrkamgjjof","reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"},"subdomain":"developers","subpath":"main","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Customer Stories","url":"https://readme.com/customers"},{"type":"url","text":"ReadMe Blog","url":"https://blog.readme.com"}],"right":[{"type":"user"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2020-10-20T22:04:19.564Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://readme.com","versions":[{"_id":"5f7ce9e3a5504d0414d0243f","codename":"Hub 2 (Pre-Docs Migration)","createdAt":"2016-05-09T19:20:09.413Z","is_deprecated":true,"project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":51,"is_beta":false,"is_hidden":true,"is_stable":false,"version":"2.0-archive","version_clean":"2.0.0-archive","categories":["5f7ce9e3a5504d0414d024bf","5f7ce9e3a5504d0414d024c0","5f7ce9e3a5504d0414d024c1","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","5f7ce9e3a5504d0414d024c2","5f7ce9e3a5504d0414d024c3","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","5f7ce9e3a5504d0414d024c4","5f7ce9e3a5504d0414d024c5","5730e2e9053a062b00cf475d","5f7ce9e3a5504d0414d024c6","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","5f7ce9e3a5504d0414d024c8","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","5f7ce9e3a5504d0414d024c9","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","5f7ce9e3a5504d0414d024e8","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","5f7ceacf43621b0311080a59","5f7cee46dd6cb1037e316144","5f7cefc76b6e5e04c3a4c74c","5f7cf1a9cb79be02e1a588c9","5f88bd664649f900680641fb","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","60189781b18d9a0012221411","61084e16a18107003124ef8f","61e1ef1e337b90003a9e11a5","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","62743670700ba00042a2b1ce","62b38d3d7447ac00937a7e04","62e2da409b967b0014077fe7","62ec4ff01f323202a13f419c","62ec516e5ad03d02680c2d9f","6320f56b35e026000f45ad58","636e6642417174009d9b563d"],"pdfStatus":"complete","updatedAt":"2025-06-30T15:39:53.492Z","apiRegistries":[{"name":"api-endpoints","url":"1yl2ql5lb604m"},{"name":"developer-metrics-api","url":"45ns416lbeakwq8"}],"source":"readme"},{"_id":"5f7ce9e3a5504d0414d0243e","version":"1.0-legacy","codename":"Hub 1","hasDoc":true,"__v":28,"is_beta":false,"is_stable":false,"project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2014-09-24T21:16:06.446Z","version_clean":"1.0.0-legacy","categories":["5f7ce9e3a5504d0414d0246a","5f7ce9e3a5504d0414d0246b","54dbf493cb6515210029556f","55dbb7ecb035900d0063fc9f","5f7ce9e3a5504d0414d0246c","5f7ce9e3a5504d0414d0246d","5f7ce9e3a5504d0414d0246e","5f7ce9e3a5504d0414d0246f","5f7ce9e3a5504d0414d02470","5f7ce9e3a5504d0414d02471","5f7ce9e3a5504d0414d02472","5f7ce9e3a5504d0414d02473","5f7ce9e3a5504d0414d02474","5f7ce9e3a5504d0414d02475","5f7ce9e3a5504d0414d02476","5f7ce9e3a5504d0414d02477","56eb18818e83410e000238d4","57206b8e5be73c17009601f3","57218435e1805f0e0042201d","5721845eecb38d0e00d80e0a","5f7ce9e3a5504d0414d024be","5a7c9d447dce000013d8b966","5bce1907c732630004f41da7","5cd20b75a35909003956cdb8","5cd20bcfa78471006231a32b","5d5b7b118fab3d00188e3cdf","5d5b7b2e99c1310020e150e9","5d5b7d8db0a1f80107d077d8","6376ba4d127d990003112b73"],"is_hidden":true,"createdAt":"2014-09-24T21:16:06.446Z","hasReference":false,"is_deprecated":true,"pdfStatus":"complete","updatedAt":"2025-05-06T17:24:27.899Z","apiRegistries":[{"name":"api-settings","url":"1mld74kq6wbkn5"}],"source":"readme"},{"_id":"62056dee230e07007218bf4c","version":"2.0","version_clean":"2.0.0","codename":"product-guides","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","62056dee230e07007218be06","62056dee230e07007218be07","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","62056dee230e07007218be09","5730e2e9053a062b00cf475d","62056dee230e07007218be0a","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","62056dee230e07007218be0e","62056dee230e07007218be0f","62056dee230e07007218be10","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","62292aea889520008ed0113b","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","624cb20585a75d004c978f57","624e2238df4eb60013286917","633470b833bb8d04e657051a","6376ba4d127d990003112b72","63e43d347c3efc02c02c5986","6442d3485ae2d10e2654d2f3","64f8c3b94e8f64001f07ea58","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","6732850c3cee9b006fe502ba","6793d83ac3512a0044428727"],"createdAt":"2016-05-09T19:20:09.413Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":17,"pdfStatus":"complete","forked_from":"5f7ce9e3a5504d0414d0243f","updatedAt":"2025-05-08T19:17:44.501Z","apiRegistries":[{"filename":"readme-api.json","uuid":"h3xgn4hm8deioh8"},{"filename":"readme-api-v2-beta.json","uuid":"h3xgn11m8deir9k"}],"gitApiRegistries":{},"source":"readme"},{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"}],"variableDefaults":[{"source":"security","type":"http","_id":"6391241e050251002a8e3d28","name":"apiKey","scheme":"basic","apiSetting":"5f7cee46dd6cb1037e316143"},{"source":"","type":"","_id":"649b525defea78003e22657d","name":"user","default":"API_KEY"},{"source":"","type":"","_id":"6352dfca576cb4000f2e14ef","name":"ReadMe","default":"Default Value"},{"source":"","type":"","_id":"63d2fc41cba521006b5197ea","name":"id","default":"README_API_KEY"},{"source":"","type":"","_id":"63efced04cc2e710b54258b1","name":"email","default":"user@example.com"},{"source":"security","type":"http","_id":"67c0a4147d2882001f56dfb6","name":"bearer","scheme":"bearer","apiSetting":"6793d83ac3512a0044428725"}],"webhookEnabled":true},"custom_domain":"docs.readme.com","childrenProjects":[{"_id":"5f7ce9e3a5504d0414d025d0","appearance":{"stylesheet_hub2":"","html_footer":"","javascript_hub2":""},"childrenProjects":[],"derivedPlan":"enterprise","description":"Beautiful documentation made easy.","isExternalSnippetActive":false,"flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newEditor":true,"oldMarkdown":false,"newMarkdownBetaProgram":false,"newApiExplorer":true,"disableAnonForum":true,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":true,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":true,"myDevelopers":true,"superHub":true,"developerDashboard":true,"allowReusableOTPs":false,"dashHomeRefresh":true,"owlbotAi":true,"apiV2":true,"git":{"read":false,"write":false},"superHubBeta":true,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":true,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":true,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://developers.readme.io/","git":{"migration":{"createRepository":{"start":"2025-02-27T20:30:21.672Z","end":"2025-02-27T20:30:22.051Z","status":"successful"},"transformation":{"end":"2025-02-27T20:30:25.564Z","start":"2025-02-27T20:30:22.422Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:30:26.543Z","start":"2025-02-27T20:30:25.602Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T21:07:41.687Z","status":"successful","end":"2025-02-27T21:07:41.688Z"}},"sync":{"linked_repository":{"_id":"67edb6060cad5a00184ac252","provider_type":"github","id":"959498828","name":"docs-developers","url":"https://github.com/readmeio/docs-developers","privacy":{"private":true,"visibility":"internal"},"linked_at":"2025-04-02T22:11:18.862Z","linked_by":"5e8b72d0e5e76b003dc97d7b","connection":"67edb600238377004599f583","full_name":"readmeio/docs-developers"},"installationRequest":{},"connections":[{"_id":"67edb600238377004599f583","active":true,"created_at":"2024-10-29T09:52:43.000Z","created_by":"5e8b72d0e5e76b003dc97d7b","installation_id":56524903,"owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"provider_type":"github"}],"providers":[]}},"shouldGateDash":false,"is_active":true,"internal":"","modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":true,"discuss":true,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"name":"ReadMe","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"owner":{"id":null,"email":null,"name":null},"readmeScore":0,"reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"stable":"679965bf6efdd80042a59378","subdomain":"developers","subpath":"main","translate":{},"webhookEnabled":false},{"_id":"6205993d7fb8d70029bba49b","appearance":{"stylesheet_hub2":"","html_footer":"","javascript_hub2":""},"childrenProjects":[],"derivedPlan":"enterprise","description":"Beautiful documentation made easy.","isExternalSnippetActive":false,"flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"swagger":true,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":true,"newEditor":true,"newEditorDash":true,"oldMarkdown":false,"newMarkdownBetaProgram":false,"useReactApp":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"singleProjectEnterprise":false,"dashReact":false,"metricsV2":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":true,"superHub":true,"allowReusableOTPs":false,"owlbotAi":false,"apiV2":true,"git":{"read":false,"write":false},"superHubBeta":true,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":true,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://enterprise-docs.readme.io/","git":{"migration":{"createRepository":{"start":"2025-02-27T20:28:11.287Z","end":"2025-02-27T20:28:11.664Z","status":"successful"},"transformation":{"end":"2025-02-27T20:28:16.384Z","start":"2025-02-27T20:28:11.907Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:28:17.068Z","start":"2025-02-27T20:28:16.423Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T20:32:50.981Z","status":"successful","end":"2025-02-27T20:32:50.981Z"}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"shouldGateDash":false,"is_active":true,"internal":"","modules":{"landing":false,"docs":true,"examples":true,"reference":false,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false},"name":"Enterprise","nav_names":{"docs":"Enterprise","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"owner":{"id":null,"email":null,"name":null},"readmeScore":0,"reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"stable":"6205993d7fb8d70029bba049","subdomain":"enterprise-docs","subpath":"ent","translate":{},"webhookEnabled":false},{"_id":"5d8907e71937f80012277b72","appearance":{"stylesheet_hub2":"","html_footer":"","javascript_hub2":""},"childrenProjects":[],"derivedPlan":"enterprise","description":"","isExternalSnippetActive":false,"flags":{"translation":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"newApiExplorer":true,"newEditor":true,"hideGoogleAnalytics":false,"cookieAuthentication":false,"allowXFrame":false,"speedyRender":false,"correctnewlines":false,"swagger":false,"oauth":false,"migrationSwaggerRun":false,"migrationRun":false,"hub2":true,"enterprise":true,"allow_hub2":false,"newMarkdown":true,"alwaysShowDocPublishStatus":false,"newMarkdownBetaProgram":false,"newMarkdownLooseMode":false,"oldMarkdown":false,"newSearch":true,"rdmdCompatibilityMode":false,"tutorials":true,"staging":false,"useReactApp":true,"allowApiExplorerJsonEditor":false,"newHeader":false,"referenceRedesign":true,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":true,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":true,"gitSidebar":true,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":true,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://rdmd.readme.io/","git":{"migration":{"createRepository":{"start":"2025-02-27T20:27:50.497Z","end":"2025-02-27T20:27:50.881Z","status":"successful"},"transformation":{"end":"2025-02-27T20:27:57.489Z","start":"2025-02-27T20:27:51.217Z","status":"successful"},"migratingPages":{"end":"2025-02-27T20:27:58.264Z","start":"2025-02-27T20:27:57.554Z","status":"successful"},"enableSuperhub":{"start":"2025-02-27T20:35:43.962Z","status":"successful","end":"2025-02-27T20:35:43.963Z"}},"sync":{"linked_repository":{"id":"942256316","name":"rdmd-docs","url":"https://github.com/readmeio/rdmd-docs","provider_type":"github","privacy":{"visibility":"internal","private":true},"linked_at":"2025-03-03T20:31:07.334Z","linked_by":"55f1d0205fe76419007dc7a9","connection":"67c611782c2069006e497eb2","full_name":"readmeio/rdmd-docs","_id":"68704c2ba6771fb1d1d0e46c"},"installationRequest":{},"connections":[{"_id":"67c611782c2069006e497eb2","active":true,"created_at":"2024-10-29T09:52:43.000Z","installation_id":56524903,"owner":{"type":"Organization","id":6878153,"login":"readmeio","site_admin":false},"provider_type":"github"}],"providers":[]}},"shouldGateDash":false,"is_active":true,"internal":"","modules":{"logs":false,"suggested_edits":true,"discuss":false,"changelog":false,"reference":false,"examples":true,"docs":true,"landing":false,"custompages":true,"tutorials":false,"graphql":false},"name":"ReadMe Markdown","nav_names":{"discuss":"","changelog":"","reference":"","docs":"","tutorials":"","recipes":""},"owner":{"id":null,"email":null,"name":null},"readmeScore":0,"reference":{"alwaysUseDefaults":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"stable":"5fdf7610134322007389a71b","subdomain":"rdmd","subpath":"","translate":{},"webhookEnabled":false}],"derivedPlan":"enterprise","description":"Beautiful documentation made easy.","isExternalSnippetActive":false,"error404":"","experiments":[],"first_page":"landing","flags":{"allow_hub2":false,"enterprise":true,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"newEditor":true,"newEditorDash":true,"oldMarkdown":false,"newMarkdownBetaProgram":true,"useReactApp":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"singleProjectEnterprise":false,"dashReact":true,"metricsV2":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":true,"forceDarkMode":false,"useReactGLP":true,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":true,"allowReusableOTPs":false,"developerDashboard":false,"dashHomeRefresh":false,"owlbotAi":true,"apiV2":false,"dashQuickstart":false,"git":{"read":false,"write":false},"superHubBeta":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":true,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":true,"superHubGlobalCustomBlocks":true,"childManagedBidi":true,"superHubBranches":false,"requiresJQuery":true,"externalSdkSnippets":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":true},"fullBaseUrl":"https://docs.readme.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[{"_id":"621044ddeed2f80083ac6d97","term":"Enterprise group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"621044f40a103000a83239db","term":"Enterprise group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6210456696b020001ae688e8","term":"Enterprise group Admin","definition":"An Enterprise group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise group, and access any related project via the project’s dashboard."},{"_id":"6210457691c8d40013dcbfd5","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"621045878fefbb00a4567123","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"621045cf9b3c01001a609907","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Some Projects."},{"_id":"621045db6d2803001a066199","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or the Enterprise Group dashboard."},{"_id":"621045f2ddd9a6007632ed4c","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"621045feb3162a0020eca3c8","term":"Some Projects","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Some Projects”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6215351976fb85003c868c8b","term":"dashboard","definition":"The dashboard or dash refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"621535251676400014e8f933","term":"hub","definition":"The hub is the end user-facing side of your project—where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"62153f32e7fa6c00264fdf08","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"m6855w1q","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"planLimit":20000000,"thumbsEnabled":true,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":true,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"name":"ReadMe Documentation","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":false,"appearance":false,"jwt":false,"api":false,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":true,"isPaying":false,"customization":{"answerLength":"long","defaultAnswer":"","forbiddenWords":"","tone":"neutral","customTone":""},"copilot":{"enabled":false,"hasBeenUsed":true,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"enterprise","planOverride":"enterprise","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"enterprise","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":true,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":230},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"62059a520d12cc006cca892c","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":[],"releaseDate":"2022-02-10T23:05:54.874Z","createdAt":"2022-02-10T23:05:54.874Z","project":"62059a520d12cc006cca892d","__v":0},"subdomain":"readme-docs-group","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Customer Stories","url":"https://readme.com/customers"},{"type":"url","text":"ReadMe Blog","url":"https://blog.readme.com/"}],"right":[{"type":"user"}],"bottom":[{"type":"home","text":"Guides","url":"Test"},{"type":"user"}],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2022-02-24T23:05:54.876Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"","versions":[{"_id":"62059a520d12cc006cca892c","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":[],"releaseDate":"2022-02-10T23:05:54.874Z","createdAt":"2022-02-10T23:05:54.874Z","project":"62059a520d12cc006cca892d","__v":0}],"variableDefaults":[{"source":"","type":"","_id":"649f33f4cae212001dcd4573","name":"dasdf","default":"aSD"}],"webhookEnabled":true},"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"3.0"},"description":"Beautiful documentation made easy.","git":{"connection":{"repository":{"full_name":"readmeio/docs-developers","name":"docs-developers","provider_type":"github","url":"https://github.com/readmeio/docs-developers"},"organization":{"name":"readmeio","provider_type":"github"},"status":"active"}},"glossary":[{"_id":"621044ddeed2f80083ac6d97","term":"Enterprise group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"621044f40a103000a83239db","term":"Enterprise group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6210456696b020001ae688e8","term":"Enterprise group Admin","definition":"An Enterprise group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise group, and access any related project via the project’s dashboard."},{"_id":"6210457691c8d40013dcbfd5","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"621045878fefbb00a4567123","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"621045cf9b3c01001a609907","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Some Projects."},{"_id":"621045db6d2803001a066199","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or the Enterprise Group dashboard."},{"_id":"621045f2ddd9a6007632ed4c","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"621045feb3162a0020eca3c8","term":"Some Projects","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Some Projects”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6215351976fb85003c868c8b","term":"dashboard","definition":"The dashboard or dash refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"621535251676400014e8f933","term":"hub","definition":"The hub is the end user-facing side of your project—where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"62153f32e7fa6c00264fdf08","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"5b57804ec6af890003de66cf","term":"Page","definition":"Also known as an article"},{"_id":"5b57805e60a07d00037870db","term":"Subpage","definition":"Under a Page"},{"_id":"5b5780787baf140003ef762b","term":"Changelog","definition":"Place where you can go see changes"},{"_id":"5b57808aa599780003538deb","term":"Discussions","definition":"Forum where your customers can share their concerns"},{"_id":"5b5780a17baf140003ef762d","term":"Documentation","definition":"Section where the documentation lives"},{"_id":"5b5780b7a599780003538ded","term":"Reference","definition":"The API Explorer"},{"_id":"5b57f37a0c8f760003f3023c","term":"pop up","definition":"You have to have explicitly use a glossary term by typing \"<<\" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term."},{"_id":"5de95d1041cd310027f8c4fb","term":"internal","definition":"Your administrators that can access the dashboard of your projects"},{"_id":"5de95d159e4c7e002f220927","term":"external","definition":"Your members that have access to the hubs"},{"_id":"5deaf50c2aa750006dbd2f3a","term":"login mechanisms","definition":"ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login"},{"_id":"6011e68de8693f0014d8d932","term":"RDMD","definition":"Our custom ReadMe-flavored Markdown engine. It's based on remark (meaning it supports all the Markdown syntax you know and love) and adds some custom syntax to support ReadMe features such as variables, glossary (i.e. what you're reading right now!), and emoji! You can read more about RDMD in our docs: rdmd.readme.io"},{"_id":"60231e0409f34c005e4dc876","term":"API Explorer","definition":"Our interactive, OpenAPI-based API reference section. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"6063c8810f5a29000f35b3f9","term":"API Reference","definition":"The API reference section of your ReadMe documentation contains information about each of your endpoints and the data that is sent and received. Users can construct and send API requests and view code samples in a language of their choice—all without leaving the docs!"},{"_id":"612d776812676f005baabd10","term":"dereferenced","definition":"The act of dereferencing all `$ref` pointers within an OpenAPI definition, replacing each reference with the value or schema that it resolves to."},{"_id":"6206b7c1ea0c3b0046a1de0c","term":"Enterprise Group","definition":"An Enterprise Group refers to the parent dashboard where all global settings are managed, including adding and removing Teammates and End Users, and managing all child projects."},{"_id":"6206b7d64516a0048e3d346c","term":"Enterprise Group Owner","definition":"There is one owner per Enterprise Group, referred to as “Owner” in the Enterprise Group dashboard. The Enterprise Group Owner has the same access privileges as an Enterprise Group Admin. Additionally, ReadMe Product Experience Managers will contact Enterprise Group Owners as the primary point of contact for decisions and updates related to renewals, beta programs, and new feature releases."},{"_id":"6206bb05eb045403e8f2320e","term":"Enterprise Group Admin","definition":"An Enterprise Group Admin is referred to as “Admin” in the Enterprise Group dashboard. Enterprise Group Admins can invite, remove, and choose the permission level of other Teammates and End Users. They can also add and remove projects from the Enterprise Group, and access any related project via the project’s dashboard."},{"_id":"6206bc6653a2eb002c07a928","term":"Project Admin","definition":"A Project Admin is the default role when you invite a team member to a ReadMe project. A Project Admin has access to a project’s dashboard and can make most team- and project-management related changes with the exception of upgrading your plan, cloning or deleting a project, and transferring project ownership, which only Project Owners can do."},{"_id":"6206bc77c66af9003f0d3ea7","term":"Project Owner","definition":"There can only be one Project Owner per ReadMe project. This role has all of the privileges of a Project Admin, with the additional abilities to upgrade your plan, clone or delete a project, and transfer project ownership."},{"_id":"6206bcae37c9d902c95e84b6","term":"Viewer","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Viewer”. The Viewer role has access to view the hubs of all child projects within an Enterprise Group, but has no access to the dashboards of the child projects or to the Enterprise Group dashboard."},{"_id":"62153fd7c4e9aa00950ea1b2","term":"variables","definition":"The variables feature allows you to assign a specific variable (e.g. name) to automatically propagate default values, across all of your documentation. We recommend using this feature for product names and links to allow for simpler bulk editing. Additionally, you can use variables to pass in user data so that aspects of your documentation are personalized for logged in users, such as their name or API key. In order to pass in personalized user data, you first need to set up custom login, which integrates with either JWT or Webhooks. You can set up variables for your project in the Variable Defaults section (within Configuration) of your dashboard."},{"_id":"62153fe068bc3e0058bb1af1","term":"dashboard","definition":"The dashboard, or dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Admins have access to the dashboard. The dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"6217d529a29ea90056b28f2b","term":"hype train","definition":"A 🚆 full of hype"},{"_id":"622fb5f271f5f406608a919f","term":"Custom","definition":"When you invite a Teammate to an Enterprise Group you have the ability to set their access to “Custom”. From there, you’ll set permission access on a per project basis as either No Access, Viewer (only hub-side access to the project), or Admin (dashboard- and hub-side access to the project)."},{"_id":"6230bd1b776d1d033e134034","term":"Teammates","definition":"Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your Enterprise Group projects. Teammates can have one of three permissions: Admin, Viewer, or Custom."},{"_id":"6230bd51fb5b3d005587bca8","term":"End Users","definition":"End Users are consumers of your ReadMe projects’ private documentation whom you’d like to grant hub-side access to. As an Enterprise customer, you can invite End Users, define project access, and configure login methods within your Enterprise Group dashboard."},{"_id":"62583c1c51d83c0353152996","term":"hub","definition":"The hub is the end user-facing side of your project, or documentation site. This is where individuals can view and interact with your documentation. For example when you set a page in your dashboard “live”, this becomes visible on the hub-side of your project. Your hub—or hubs if you have multiple projects—is updated through your project’s dashboard. Your hub is visible to anyone with the URL for your documentation, unless you set your project to private."},{"_id":"64da475bf12f5d0b6eb764fb","term":"Slug","definition":"A URL slug last identifying string of a specific page.\n\nThe slug for https://docs.readme.com/main/docs/intro-to-readme is \"intro-to-readme\""},{"_id":"64da47a94a89fd11c7884cec","term":"dash","definition":"The Dashboard, or Dash, refers to the admin panel of ReadMe’s platform where all of your projects and settings are housed. Only Project Owners and Admins have access to the Dashboard. The Dashboard is where Admins can edit projects, create and edit documentation, and more."},{"_id":"64da49a3af7e2f00190b8748","term":"Glossary","definition":"Glossary terms allow users to provide additional context to specific words or phrases when a viewer hovers over that term. Terms are defined in plaintext under Project Dashboard > Glossary. When editing content, type \"<<\" to insert a Glossary term!"}],"homepage_url":"https://readme.com","id":"5f7ce9e3a5504d0414d025d0","name":"ReadMe","parent":null,"redirects":[],"sitemap":"disabled","llms_txt":"disabled","subdomain":"developers","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"dasdf","default":"aSD","source":"","type":"","id":"649f33f4cae212001dcd4573"},{"name":"apiKey","scheme":"basic","source":"security","type":"http","id":"6391241e050251002a8e3d28"},{"name":"user","default":"API_KEY","source":"","type":"","id":"649b525defea78003e22657d"},{"name":"ReadMe","default":"Default Value","source":"","type":"","id":"6352dfca576cb4000f2e14ef"},{"name":"id","default":"README_API_KEY","source":"","type":"","id":"63d2fc41cba521006b5197ea"},{"name":"email","default":"user@example.com","source":"","type":"","id":"63efced04cc2e710b54258b1"},{"name":"bearer","scheme":"bearer","source":"security","type":"http","id":"67c0a4147d2882001f56dfb6"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"enabled"},"mcp":{},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":true,"metricsSDK":true},"pages":{"not_found":"/branches/stable/custom_pages/404"},"privacy":{"openapi":"admin","password":null,"view":"public"},"refactored":{"status":"enabled","migrated":"successful"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"enterprise","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2020-10-20T22:04:19.564Z"}},"reference":{"api_sdk_snippets":"enabled","defaults":"use_only_if_required","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"expanded","sdk_snippets":{"external":"disabled"}},"health_check":{"provider":"statuspage","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":"nz3r09cr7dk1"}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"postman":{"key":null,"client_id":null,"client_secret":null},"recaptcha":{"site_key":"6LdHWIgcAAAAAEDbyrvc-xSVdHo2tRjrkamgjjof","secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"stainless":{"key":null,"name":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":"m6855w1q","secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"enabled"}},"branches":{"merge":{"admin":true}}},"appearance":{"brand":{"primary_color":"#018EF5","link_color":null,"theme":"system"},"changelog":{"layout":"continuous","show_author":false,"show_exact_date":true},"layout":{"full_width":"enabled","style":"compact"},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":"What's Next","footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":"/images/685dd8f46f4ed500741941a3","url":"https://files.readme.io/3230046a081b5585dda1f4fb336a1ed3f182d4f677000a7343a5f6e81fb0414e-logo_dark.svg","name":"3230046a081b5585dda1f4fb336a1ed3f182d4f677000a7343a5f6e81fb0414e-logo_dark.svg","width":null,"height":null,"color":"#000000","links":{"original_url":null}},"main":{"uri":"/images/685dd8f1a937400018078851","url":"https://files.readme.io/cad5441be73105b537fc281d974e5e183158da735ea4502567c4544bd1db1589-logo_light.svg","name":"cad5441be73105b537fc281d974e5e183158da735ea4502567c4544bd1db1589-logo_light.svg","width":null,"height":null,"color":"#018ef5","links":{"original_url":null}},"favicon":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}},"custom_code":{"css":"[data-color-mode=\"dark\"] {\n\t--color-bg-page: var(--gray0);\n}\n\n@media (prefers-color-scheme: dark) {\n\t[data-color-mode=\"system\"] {\n\t\t--color-bg-page: var(--gray0);\n\t}\n}\n\n.Spinner_overlay {\n\tbackground: var(--color-bg-page);\n}\n.rm-Changelog .markdown-body p:first-of-type {\n font-size: 1.25em;\n margin: 30px 0;\n}\n\n.rm-Changelog .markdown-body h2 + p {\n font-size: 1.25em;\n}\n\n.rm-Changelog .markdown-body h3 {\n margin-top: 30px;\n}\n\n.rm-Changelog .badge {\n background: linear-gradient(160deg, rgba(0,0,0,0.25), rgba(89,75,159,0.75) 10%) black;\n box-shadow: inset 0 0 0 1px var(--color-border-default);\n border-radius: 1em;\n color: white;\n display: inline-block;\n filter: brightness(1.15) saturate(2.5);\n font-size: 10px;\n font-family: var(--font-family);\n line-height: 1;\n overflow: hidden;\n padding: 0.35em 0.65em;\n position: relative;\n text-decoration: none !important;\n transition: filter var(--transition-slow) var(--transition-timing); \n top: 0.3em;\n\n &:hover,\n &:active,\n &:focus {\n color: white;\n filter: brightness(1.4) saturate(2.5);\n text-decoration: none !important;\n }\n}\n\n[data-color-mode=\"system\"] .rm-Changelog .badge {\n @media (prefers-color-scheme: dark) {\n filter: brightness(1.15) saturate(1.75);\n }\n}\n\n[data-color-mode=\"dark\"] .rm-Changelog .badge {\n filter: brightness(1.15) saturate(1.75);\n}\n\n@media print {\n .rm-Header,\n .rm-Sidebar,\n .rm-Header-bottom,\n .rm-Header-top,\n .rm-Header-top .rm-Header-left,\n .rm-Header-top .rm-Header-right,\n .rm-PageThumbs,\n .rm-Pagination,\n .UpdatedAt,\n .NextStepsDivider,\n .suggestEdits,\n .heading-anchor-icon,\n .intercom-lightweight-app-launcher,\n .reference-flyout {\n display: none !important;\n }\n \n .rm-Article {\n\t max-width: none !important;\n }\n \n .content-body {\n width: auto !important;\n }\n \n .rm-ReferenceMain > .Flex_row {\n\t align-items: center !important;\n\t flex-direction: column !important;\n }\n \n .rm-Playground {\n\t box-shadow: none !important;\n\t max-width: none;\n }\n}","js":null,"html":{"header":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"link_style":"tabs","overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"ai":{"dropdown":"enabled","options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","view_as_markdown":"enabled"}},"navigation":{"first_page":"documentation","left":[{"type":"link_url","title":"Customer Stories","url":"https://readme.com/customers","custom_page":null},{"type":"link_url","title":"ReadMe Blog","url":"https://blog.readme.com","custom_page":null}],"logo_link":"homepage","page_icons":"enabled","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"enabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"enabled"}}}}}},"version":{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"}},"is404":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/main/docs/discussion-forums","version":{"_id":"679965bf6efdd80042a59378","version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62056dee230e07007218be04","5f7ce9e3a5504d0414d024c0","62056dee230e07007218be05","5730e2e9053a062b00cf4754","5730e2e9053a062b00cf4755","679965bf6efdd80042a5925d","679965bf6efdd80042a5925e","5730e2e9053a062b00cf4758","5730e2e9053a062b00cf4759","5730e2e9053a062b00cf475a","62056dee230e07007218be08","679965bf6efdd80042a5925f","5730e2e9053a062b00cf475d","679965bf6efdd80042a59260","5730e2e9053a062b00cf475f","5f7ce9e3a5504d0414d024c7","57e31e95611a860e00f97e22","582fa20c4479222092198d40","5849c782fcabe31900998f6e","58b9e83068a4a5190011dcb2","58bdec0f455ca125001d9505","5a6bbecf2116e20022de8b19","5a7c96d2324bc1001f64ad8b","5a7c9d777dce000013d8b96f","5a81e7ff761cf30012731823","5a81e886bf4a2b0012592b49","5a81eaa5761cf3001273183d","62056dee230e07007218be0b","5a95f47858371e001fd651bb","5a95f53b5c3020002b02aa8c","5a95f57c4091e600125d0249","5a95f5984c0ecf0046a28ba3","5a95f6754091e600125d0252","5a95f6b94091e600125d025b","5a95f7104c0ecf0046a28bce","5a95f7954c0ecf0046a28c57","5a95f7d15c3020002b02aacf","5af6287d426c9d000377c583","5afdf7d37506a80003730d40","5b359df811baf70003a14454","62056dee230e07007218be0c","5bbbb66b8dac1100048174f0","5bbbb6768dac1100048174f3","62056dee230e07007218be0d","5c6f5766877e850021140a1a","5ca51733d177a40373ab97f9","5cc26539681cf8001b9ce9f3","5d0aa5163fd65b0019f2d14e","5d0bba3dd628fd0051fbb232","5d0bba522df6470020205266","5d0bce567f3ac6000f0ef6a3","5d1a4e276ffc8100194874f2","5d3213a673f65d0012b11fb0","5d5b7af3e33f0b005608b793","5d5b7b1d68f1dc00113744d4","5d5b7b9f0c74ae001e8e2186","5d5b7beffe91cc002f6d67eb","5d5b7c21fbd0f80012334964","5d5b7c2df20ff50052c02fec","5dc9f8a8ea4314002f5575ff","5dcdad4c3fd5ca0052534ac4","5e1e2350f309936b889b2448","5f7ce9e3a5504d0414d024fd","679965bf6efdd80042a59261","679965bf6efdd80042a59262","679965bf6efdd80042a59263","5f7cf1a9cb79be02e1a588c9","62056dee230e07007218be11","5f9c861053998401d1c2c222","5fc55b794fd67b00645d25e2","62056dee230e07007218be12","61084e16a18107003124ef8f","62056dee230e07007218be13","61e1f0d7a8a68f007059c4cb","61e1f0fc0106310039807732","679965bf6efdd80042a59264","6233cab9410abc001c9822eb","6234eb59f6eccc02f76cb807","679965bf6efdd80042a59265","624e2238df4eb60013286917","679965bf6efdd80042a59266","679965bf6efdd80042a59267","63e43d347c3efc02c02c5986","679965bf6efdd80042a59268","679965bf6efdd80042a59269","650b7bdc6fa4eb0074722335","65848b391e628e004514a0df","65848bb94819f1004aa6338e","658493ce0d7680006b35bd9d","679965bf6efdd80042a5926a","679965bf6efdd80042a5926b","679abd57e5f861000fb73b4b","679ac1cd323420001edd42d7","67b6e40340f2a5001e9a8195"],"pdfStatus":"complete","createdAt":"2025-01-28T23:18:21.093Z","project":"5f7ce9e3a5504d0414d025d0","releaseDate":"2016-05-09T19:20:09.413Z","__v":194,"forked_from":"62056dee230e07007218bf4c","updatedAt":"2025-07-18T20:40:57.534Z","apiRegistries":[{"filename":"readme-api.json","uuid":"gdmj8lmd9aaegf"},{"filename":"readme-api-v2-beta.json","uuid":"1ntw16md9a9nd9"}],"source":"readme"},"gitVersion":{"base":"2.0","display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:10.000Z","uri":"/branches/3.0","privacy":{"view":"default"}},"versions":{"total":4,"page":1,"per_page":100,"paging":{"next":null,"previous":null,"first":"/developers/api-next/v2/branches?page=1&per_page=100","last":null},"data":[{"base":null,"display_name":"Hub 1","name":"1.0-legacy","release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-02-27T20:33:51.348Z","uri":"/branches/1.0-legacy","privacy":{"view":"hidden"}},{"base":null,"display_name":"Hub 2 (Pre-Docs Migration)","name":"2.0-archive","release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-02-27T20:46:07.026Z","uri":"/branches/2.0-archive","privacy":{"view":"hidden"}},{"base":"2.0-archive","display_name":"product-guides","name":"2.0","release_stage":"release","source":"readme","state":"deprecated","updated_at":"2025-05-08T20:44:43.581Z","uri":"/branches/2.0","privacy":{"view":"hidden"}},{"base":"2.0","display_name":null,"name":"3.0","release_stage":"release","source":"readme","state":"current","updated_at":"2025-07-18T20:40:11.015Z","uri":"/branches/3.0","privacy":{"view":"default"}}],"type":"version"}}">
![\"\"](\"https://files.readme.io/55d847d-CleanShot_2022-10-17_at_17.27.00.png\" "\\"\\"")
![\"\"](\"https://files.readme.io/0b1a867-CleanShot_2022-10-17_at_17.37.12.png\" "\\"\\"")
![\"\"](\"https://files.readme.io/029faef-new_Editor_in_discussions.gif\" "\\"\\"")
![\"\"](\"https://files.readme.io/91c39b1-CleanShot_2022-10-17_at_17.40.22.png\" "\\"\\"")
![\"\"](\"https://files.readme.io/679ed3a-CleanShot_2022-10-17_at_17.40.22_2.png\" "\\"\\"")
![\"\"](\"https://files.readme.io/8765d2e-CleanShot_2022-10-17_at_17.44.01.png\" "\\"\\"")
![](\"https://files.readme.io/563527b-rr-owlbert.png\")