II.
LibraryProcess overview
Reference · livelib-process:technical-documentation--docs-versioning
specializations/technical-documentation/docs-versioning overview
Documentation Versioning and Release Coordination - Automated process for managing documentation versions aligned with product releases, including version switcher implementation, semantic versioning, deprecation notices, migration guides, changelog generation, and multi-version hosting setup.
Attributes
displayName
specializations/technical-documentation/docs-versioning
description
Documentation Versioning and Release Coordination - Automated process for managing documentation
versions aligned with product releases, including version switcher implementation, semantic versioning,
deprecation notices, migration guides, changelog generation, and multi-version hosting setup.
libraryPath
library/specializations/technical-documentation/docs-versioning.js
specialization
technical-documentation
references
- - Semantic Versioning: https://semver.org/
- - Docusaurus Versioning: https://docusaurus.io/docs/versioning
- - MkDocs Material Versioning: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
- - VuePress Versioning: https://vuepress.vuejs.org/guide/deploy.html#versioning
- - Documentation Version Management: https://documentation.divio.com/
example
const result = await orchestrate('specializations/technical-documentation/docs-versioning', {
productName: 'MyAPI',
currentVersion: '2.1.0',
docsPath: './docs',
platform: 'docusaurus', // 'docusaurus', 'mkdocs', 'vuepress', 'custom'
versioningStrategy: 'semantic', // 'semantic', 'date-based', 'major-only'
hostingPlatform: 'github-pages', // 'github-pages', 'netlify', 'vercel', 'readthedocs'
previousVersions: ['2.0.0', '1.9.0', '1.8.0'],
includeDeprecations: true,
generateMigrationGuides: true,
retentionPolicy: { keepMajorVersions: 'all', keepMinorVersions: 2, archiveAfterYears: 2 },
releaseNotes: { source: 'git', format: 'markdown' }
});
usesAgents
- docusaurus
- markdown-mdx
- link-validator
- git-github-flow
- tech-writing-lint
- pdf-generation
Outgoing edges
lib_applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
lib_belongs_to_specialization1
- specialization:technical-documentation·Specialization
lib_implements_workflow1
- workflow:documentation-sprint·WorkflowDocumentation Sprint
lib_involves_role2
- role:technical-writer·RoleTechnical Writer
- role:documentation-engineer·RoleDocumentation Engineer
lib_requires_skill_area2
- skill-area:docs-as-code·SkillAreaDocs-as-Code
- skill-area:reference-docs·SkillAreaReference Documentation
Incoming edges
None.