sap-samples/hana-developer-cli-tool-example/docs-automation

Docs Automation Skill

Use this skill for documentation generation and maintenance tasks.

When to Use

• Regenerating command documentation in docs/02-commands/
• Enhancing command docs after generation
• Updating or regenerating the VitePress sidebar
• Validating doc builds and link consistency

Procedure

1. Identify the docs scope (all commands vs specific folders).
2. Run the relevant automation scripts:

• scripts/generate-command-docs.js
• scripts/enhance-command-docs.js
• scripts/populate-command-docs.js
• scripts/generate-sidebar-config.js or scripts/generate-sidebar-config-fixed.js

1. Spot-check updated markdown for formatting and taxonomy alignment.
2. If needed, run vitepress build docs to validate the output.

Notes

• Follow the command documentation instructions for docs/02-commands/.
• Preserve existing category names and ordering in the sidebar.
• Use existing scripts rather than manual edits whenever possible.

References

• Docs automation checklist