Name: index-docs
Author: muratkeremozcan

Prompt file imported from muratkeremozcan/bmad-submodule (.windsurf/workflows/bmad/core/tasks/index-docs.md). Copyright stays with the author.

MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER DO NOT skip steps or change the sequence HALT immediately when halt-conditions are met Each action xml tag within step xml tag is a REQUIRED action to complete that step Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution

<step n="2" title="Group Content">
  <i>Organize files by type, purpose, or subdirectory</i>
</step>

<step n="3" title="Generate Descriptions">
  <i>Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the
    filename</i>
</step>

<step n="4" title="Create/Update Index">
  <i>Write or update index.md with organized file listings</i>
</step>

  ## Files

  - **[filename.ext](./filename.ext)** - Brief description
  - **[another-file.ext](./another-file.ext)** - Brief description

  ## Subdirectories

  ### subfolder/

  - **[file1.ext](./subfolder/file1.ext)** - Brief description
  - **[file2.ext](./subfolder/file2.ext)** - Brief description

  ### another-folder/

  - **[file3.ext](./another-folder/file3.ext)** - Brief description
</example>

<task id="_bmad/core/tasks/index-docs" name="Index Docs" description="Generates or updates an index.md of all documents in the specified directory" webskip="true" standalone="true"> <llm critical="true"> MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER DO NOT skip steps or change the sequence HALT immediately when halt-conditions are met Each action xml tag within step xml tag is a REQUIRED action to complete that step Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution </llm> <flow> <step n="1" title="Scan Directory"> List all files and subdirectories in the target location </step> <step n="2" title="Group Content"> Organize files by type, purpose, or subdirectory </step> <step n="3" title="Generate Descriptions"> Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename </step> <step n="4" title="Create/Update Index"> Write or update index.md with organized file listings </step> </flow> <output-format> <example> # Directory Index ## Files - **[filename.ext](./filename.ext)** - Brief description - **[another-file.ext](./another-file.ext)** - Brief description ## Subdirectories ### subfolder/ - **[file1.ext](./subfolder/file1.ext)** - Brief description - **[file2.ext](./subfolder/file2.ext)** - Brief description ### another-folder/ - **[file3.ext](./another-folder/file3.ext)** - Brief description </example> </output-format> <halt-conditions critical="true"> HALT if target directory does not exist or is inaccessible HALT if user does not have write permissions to create index.md </halt-conditions> <validation> Use relative paths starting with ./ Group similar files together Read file contents to generate accurate descriptions - don't guess from filenames Keep descriptions concise but informative (3-10 words) Sort alphabetically within groups Skip hidden files (starting with .) unless specified </validation> </task>

{ "prompt": "<task id=\"_bmad/core/tasks/index-docs\" name=\"Index Docs\"\n description=\"Generates or updates an index.md of all documents in the specified directory\" webskip=\"true\" standalone=\"true\">\n <llm critical=\"true\">\n MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER\n DO NOT skip steps or change the sequence\n HALT immediately when halt-conditions are met\n Each action xml tag within step xml tag is a REQUIRED action to complete that step\n Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution\n </llm>\n\n <flow>\n <step n=\"1\" title=\"Scan Directory\">\n List all files and subdirectories in the target location\n </step>\n\n <step n=\"2\" title=\"Group Content\">\n Organize files by type, purpose, or subdirectory\n </step>\n\n <step n=\"3\" title=\"Generate Descriptions\">\n Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the\n filename\n </step>\n\n <step n=\"4\" title=\"Create/Update Index\">\n Write or update index.md with organized file listings\n </step>\n </flow>\n\n <output-format>\n <example>\n # Directory Index\n\n ## Files\n\n - **[filename.ext](./filename.ext)** - Brief description\n - **[another-file.ext](./another-file.ext)** - Brief description\n\n ## Subdirectories\n\n ### subfolder/\n\n - **[file1.ext](./subfolder/file1.ext)** - Brief description\n - **[file2.ext](./subfolder/file2.ext)** - Brief description\n\n ### another-folder/\n\n - **[file3.ext](./another-folder/file3.ext)** - Brief description\n </example>\n </output-format>\n\n <halt-conditions critical=\"true\">\n HALT if target directory does not exist or is inaccessible\n HALT if user does not have write permissions to create index.md\n </halt-conditions>\n\n <validation>\n Use relative paths starting with ./\n Group similar files together\n Read file contents to generate accurate descriptions - don't guess from filenames\n Keep descriptions concise but informative (3-10 words)\n Sort alphabetically within groups\n Skip hidden files (starting with .) unless specified\n </validation>\n</task>", "variables": [], "notes": "task-index-docs", "metadata": { "source": { "provider": "github-windsurf-workflows", "repository": "https://github.com/muratkeremozcan/bmad-submodule", "path": ".windsurf/workflows/bmad/core/tasks/index-docs.md", "ref": "fdd7d3649367058360f354f1b9c15824ff10589b", "url": "https://github.com/muratkeremozcan/bmad-submodule/blob/fdd7d3649367058360f354f1b9c15824ff10589b/.windsurf/workflows/bmad/core/tasks/index-docs.md", "key": "muratkeremozcan/bmad-submodule/.windsurf/workflows/bmad/core/tasks/index-docs.md" } } }

index-docs

About

Use it

Manifest

Reviews