1b87e4555f
* WIP * updates * docs updates * structure * big structure update * docs module icon change * in-app docs nav * more content and structure changes * Remove redundant * Fix docs build in app Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
1.6 KiB
Documentation
An internal set of guides and docs for the installed version of the platform, including an API Reference that is dynamically tailored to your custom schema.
Docs for the latest version of the platform are available via https://docs.directus.io, and version-specific docs are included within the App itself as a core module. Both sets come from the same source of markdown files on GitHub, making them easy for anyone to work with.
Below are the six main sections of the platform's documentation, as well as descriptions of each.
- Getting Started — For anyone who is unfamiliar with the platform
- App Guide — For users (non-technical or technical) of the platform's no-code App
- Configuration — For administrators installing and setting up the platform
- API Reference — For developers connecting with data via the platform's API toolkit
- Extensions — For developers creating custom experiences on top of the platform
- Contributing — For developers working on the platform's open-source core
::: tip In-App Exclusions
Docs included within the app intentionally exclude certain pages, such as "Installation", as these sections are not relevant to running instances of the platform. Additionally, some sections may be hidden based on your role as a user versus a more technical administrator.
:::