Name: Update Markdown Docs
Author: SAP-samples

Prompt file imported from SAP-samples/hana-developer-cli-tool-example (.github/prompts/update-markdown-docs.prompt.md). Copyright stays with the author.

You are updating Markdown documentation in this repository. Use the user-provided arguments to identify the doc path(s) and the desired change.

Requirements:

Read and follow the existing documentation style in this repo (headings, tables, tone, examples).
If the target is under docs/02-commands/, follow the command-doc rules in command documentation instructions.
Keep changes minimal and consistent with existing structure.
Use accurate terminology that matches the CLI and the repository.
After updates, perform a consistency-only cross-check against the current command implementations and document structure (no command execution unless explicitly requested).

Output:

Apply edits to the specified Markdown file(s).
Provide a concise summary of what changed and why.
Report the cross-check results (consistency and alignment findings).

You are updating Markdown documentation in this repository. Use the user-provided arguments to identify the doc path(s) and the desired change. Requirements: - Read and follow the existing documentation style in this repo (headings, tables, tone, examples). - If the target is under `docs/02-commands/`, follow the command-doc rules in [command documentation instructions](../instructions/command-documentation.instructions.md). - Keep changes minimal and consistent with existing structure. - Use accurate terminology that matches the CLI and the repository. - After updates, perform a consistency-only cross-check against the current command implementations and document structure (no command execution unless explicitly requested). Output: - Apply edits to the specified Markdown file(s). - Provide a concise summary of what changed and why. - Report the cross-check results (consistency and alignment findings).

{ "prompt": "You are updating Markdown documentation in this repository. Use the user-provided arguments to identify the doc path(s) and the desired change.\n\nRequirements:\n- Read and follow the existing documentation style in this repo (headings, tables, tone, examples).\n- If the target is under `docs/02-commands/`, follow the command-doc rules in [command documentation instructions](../instructions/command-documentation.instructions.md).\n- Keep changes minimal and consistent with existing structure.\n- Use accurate terminology that matches the CLI and the repository.\n- After updates, perform a consistency-only cross-check against the current command implementations and document structure (no command execution unless explicitly requested).\n\nOutput:\n- Apply edits to the specified Markdown file(s).\n- Provide a concise summary of what changed and why.\n- Report the cross-check results (consistency and alignment findings).", "variables": [], "notes": "Create or update Markdown documentation in this repo with existing style Arguments: Doc path(s) + intent (e.g., docs/02-commands/data-sync/compare.md: add options section).", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/SAP-samples/hana-developer-cli-tool-example", "path": ".github/prompts/update-markdown-docs.prompt.md", "ref": "26cbc4ee54405fead738f2be0458ec541f80207f", "url": "https://github.com/SAP-samples/hana-developer-cli-tool-example/blob/26cbc4ee54405fead738f2be0458ec541f80207f/.github/prompts/update-markdown-docs.prompt.md", "key": "SAP-samples/hana-developer-cli-tool-example/.github/prompts/update-markdown-docs.prompt.md" } } }

Update Markdown Docs

About

Use it

Manifest

Reviews