Skip to content

Commit ed8a41a

Browse files
authored
Mark Documentation plugin as unmaintained
1 parent 9a54a7a commit ed8a41a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Diff for: docusaurus/docs/cms/plugins/documentation.md

+4
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ The Documentation plugin automates your API documentation creation. It basically
3030
</IdentityCardItem>
3131
</IdentityCard>
3232

33+
:::caution Unmaintained plugin
34+
The Documentation plugin is not actively maintained and may not work with Strapi 5.
35+
:::
36+
3337
<Guideflow lightId="5pvjz4zswp" darkId="6kw4vdwizp"/>
3438

3539
If installed, the Documentation plugin will inspect content types and routes found on all APIs in your project and any plugin specified in the configuration. The plugin will then programmatically generate documentation to match the <ExternalLink to="https://swagger.io/specification/" text="OpenAPI specification"/>. The Documentation plugin generates the <ExternalLink to="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#paths-object" text="paths objects"/> and <ExternalLink to="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object" text="schema objects"/> and converts all Strapi types to <ExternalLink to="https://swagger.io/docs/specification/data-models/data-types/" text="OpenAPI data types"/>.

0 commit comments

Comments
 (0)