What is the Developer Portal Documentation Service?
The Developer Portal Documentation Service enables developers to write project documentation with markdown files in their own git repositories. The documentation is then automatically synced and published to the documentation portal.
Key capabilities
- Markdown documentation — write docs in markdown, rendered with Docsify.
- OpenAPI/Swagger — publish API definitions in JSON or YAML, rendered with ReDoc.
- Public and private access — control visibility per document: public, TechPass login, or specific email domains.
- Git-based workflow — documentation lives in your Git repository and syncs automatically on push.
- Mermaid diagrams — embed flowcharts, sequence diagrams, Gantt charts, and more.
- Collapsible sidebar — nested, collapsible navigation with automatic table of contents.
Why is technical documentation necessary?
Technical documentation is crucial for users to understand and use your software and its APIs. It helps you support customers better while significantly improving user satisfaction with your product.
Public and private documentation
You can choose who can access your documentation: the public, logged-in users*, or users with specific emails or email domains.
* only TechPass users
Write in markdown or OpenAPI/Swagger
The developer documentation portal supports two documentation formats:
- Markdown, rendered with the Docsify documentation renderer.
- OpenAPI (also known as Swagger) definitions in JSON or YAML, rendered through the ReDoc API documentation renderer.
How to publish documentation
Follow these steps to publish your documentation:
We have a template that you can download to get started. You can use either GitLab or GitHub for version control.
Template that you can clone to get started: SGTS DevPortal Docs Portal Content Starter Kit
You will need a TechPass and GitLab account. Get started today!
AI-assisted publishing (recommended)
We recommend using Claude Code with the Doc Portal skill when writing and maintaining your documentation. The skill gives Claude Code built-in knowledge of the portal’s non-standard link resolution, Docsify configuration, and validation rules — so it can catch broken links, fix sidebar references, and apply platform conventions as you write.
gt apd install gdp-doc-portalSee AI-assisted publishing in Get started for prerequisites and setup.
Support
For questions or issues with publishing, reach out on #ask-dev-portal on Slack.