How do I install the Backstage Techdocs skill?

Run npx skillmds@latest add paulasilvatech/backstage-techdocs in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Backstage Techdocs safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Backstage Techdocs?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Backstage Techdocs free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Backstage Techdocs?

paulasilvatech (@paulasilvatech) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Backstage Techdocs by paulasilvatech

Name: Backstage Techdocs
Author: paulasilvatech

Backstage Techdocs

Configure, build, preview, publish, migrate, and troubleshoot Backstage TechDocs and MkDocs content. Use when handling techdocs-ref annotations, mkdocs.yml, local or external builders, object-storage publishers, CI generation, broken docs, or wiki-to-TechDocs migration.

File contents

Backstage TechDocs

Keep documentation source-controlled with its owner, validate generation before publication, and separate authoring from storage credentials.

When to invoke

"Add TechDocs to this service."
"Preview or fix a TechDocs build."
"Move wiki content into repository docs."
"Configure external TechDocs generation and publication."

Procedure

Detect Backstage version, TechDocs builder mode, generator, publisher, storage, and CI workflow.
Confirm the catalog entity and backstage.io/techdocs-ref source.
Validate the source layout, mkdocs.yml, docs/index.md, navigation, links, and approved plugins.
For migrations, inventory source pages, preserve ownership and redirects where applicable, and avoid copying credentials or private operational data.
Run local TechDocs or MkDocs generation using the repository's existing command.
Inspect warnings, generated navigation, links, assets, and rendering.
For external builders, update CI and publication configuration without storing cloud credentials in the documentation repository.
Require explicit approval before publishing, changing storage, or deleting previously published content.
Validate the Backstage reader route after publication when runtime access is available.

Deployment modes

Mode	Use
Local builder	Development and small trusted installations.
External builder	CI-based production generation with controlled publication.
External source	Documentation sourced from another approved location.

Output template

## TechDocs result

**Entity:** <entity ref>
**Builder:** <local or external>
**Publisher:** <type>

| Check | Result |
| --- | --- |

### Publication
- Approval: <approved | not requested | blocked>
- Result: <published | not run | failed>

Quality gate

The entity source and TechDocs annotation are valid.
MkDocs config, navigation, links, plugins, and source files validate.
Local generation succeeds before publication.
Credentials remain external to docs and config examples.
Publication or deletion is explicitly approved.
Reader access is validated or reported as not tested.

---name: backstage-techdocsdescription: Configure, build, preview, publish, migrate, and troubleshoot Backstage TechDocs and MkDocs content. Use when handling techdocs-ref annotations, mkdocs.yml, local or external builders, object-storage publishers, CI generation, broken docs, or wiki-to-TechDocs migration.---# Backstage TechDocsKeep documentation source-controlled with its owner, validate generation before publication, andseparate authoring from storage credentials.## When to invoke- "Add TechDocs to this service."- "Preview or fix a TechDocs build."- "Move wiki content into repository docs."- "Configure external TechDocs generation and publication."## Procedure1. Detect Backstage version, TechDocs builder mode, generator, publisher, storage, and CI workflow.2. Confirm the catalog entity and `backstage.io/techdocs-ref` source.3. Validate the source layout, `mkdocs.yml`, `docs/index.md`, navigation, links, and approved plugins.4. For migrations, inventory source pages, preserve ownership and redirects where applicable, and avoid copying credentials or private operational data.5. Run local TechDocs or MkDocs generation using the repository's existing command.6. Inspect warnings, generated navigation, links, assets, and rendering.7. For external builders, update CI and publication configuration without storing cloud credentials in the documentation repository.8. Require explicit approval before publishing, changing storage, or deleting previously published content.9. Validate the Backstage reader route after publication when runtime access is available.## Deployment modes| Mode | Use || --- | --- || Local builder | Development and small trusted installations. || External builder | CI-based production generation with controlled publication. || External source | Documentation sourced from another approved location. |## Output template```markdown## TechDocs result**Entity:** <entity ref>**Builder:** <local or external>**Publisher:** <type>| Check | Result || --- | --- |### Publication- Approval: <approved | not requested | blocked>- Result: <published | not run | failed>```## Quality gate- [ ] The entity source and TechDocs annotation are valid.- [ ] MkDocs config, navigation, links, plugins, and source files validate.- [ ] Local generation succeeds before publication.- [ ] Credentials remain external to docs and config examples.- [ ] Publication or deletion is explicitly approved.- [ ] Reader access is validated or reported as not tested.

Frequently asked questions