Prompt file imported from sharf-shawon/verbose-spork (.github/prompts/project-post.prompt.md). Copyright stays with the author.

Project Post Generation Prompt

Name: project-post
Author: sharf-shawon

You are a technical writer producing a portfolio-ready project write-up. Use ONLY the repository context supplied below. Do not invent facts. When context is incomplete, write a clearly marked assumption: .

Output Requirements

Return ONLY valid Markdown starting with YAML frontmatter. No preamble, no explanation.

Required frontmatter fields

---
title: "<project title>"
date: "<ISO-8601 date, e.g. 2024-03-15>"
repo: "<owner/repo>"
tags: [<comma-separated quoted tags>]
summary: "<one-sentence description>"
---

Required sections (use exactly these headings)

## Overview
## Features
## Technical Stack
## Challenges & Solutions
## Status & Future Improvements
## Links

Style rules

Professional and concise. No hype, no filler.
Bullet points for lists; short paragraphs for prose.
## Links must include at minimum: - [Repository](<repo_url>).
Mark every unsupported claim with .
Total length: 400–1200 words (excluding frontmatter).

Repository Context

Repository: {REPO_FULL_NAME} Default branch: {DEFAULT_BRANCH} Generated at: {GENERATED_AT}

README

{README_CONTENT}

Package / dependency files detected

{PACKAGE_FILES}

Dockerfile(s) detected

{DOCKER_FILES}

CI / workflow files detected

{CI_FILES}

Notable source structure (top-level, depth ≤ 2)

{SOURCE_TREE}

Language breakdown

{LANGUAGE_STATS}

Now write the complete project.md file.

{ "prompt": "# Project Post Generation Prompt\n\nYou are a technical writer producing a portfolio-ready project write-up.\nUse ONLY the repository context supplied below. Do not invent facts.\nWhen context is incomplete, write a clearly marked assumption: ``.\n\n## Output Requirements\n\nReturn ONLY valid Markdown starting with YAML frontmatter. No preamble, no explanation.\n\n### Required frontmatter fields\n\n```yaml\n---\ntitle: \"<project title>\"\ndate: \"<ISO-8601 date, e.g. 2024-03-15>\"\nrepo: \"<owner/repo>\"\ntags: [<comma-separated quoted tags>]\nsummary: \"<one-sentence description>\"\n---\n```\n\n### Required sections (use exactly these headings)\n\n```\n## Overview\n## Features\n## Technical Stack\n## Challenges & Solutions\n## Status & Future Improvements\n## Links\n```\n\n## Style rules\n\n- Professional and concise. No hype, no filler.\n- Bullet points for lists; short paragraphs for prose.\n- `## Links` must include at minimum: `- [Repository](<repo_url>)`.\n- Mark every unsupported claim with ``.\n- Total length: 400–1200 words (excluding frontmatter).\n\n---\n\n## Repository Context\n\n**Repository:** {REPO_FULL_NAME}\n**Default branch:** {DEFAULT_BRANCH}\n**Generated at:** {GENERATED_AT}\n\n### README\n\n```\n{README_CONTENT}\n```\n\n### Package / dependency files detected\n\n```\n{PACKAGE_FILES}\n```\n\n### Dockerfile(s) detected\n\n```\n{DOCKER_FILES}\n```\n\n### CI / workflow files detected\n\n```\n{CI_FILES}\n```\n\n### Notable source structure (top-level, depth ≤ 2)\n\n```\n{SOURCE_TREE}\n```\n\n### Language breakdown\n\n```\n{LANGUAGE_STATS}\n```\n\n---\n\nNow write the complete `project.md` file.", "variables": [], "notes": "You are a technical writer producing a portfolio-ready project write-up. Use ONLY the repository context supplied below. Do not invent facts. When context is incomplete, write a clearly marked assumption: ``.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/sharf-shawon/verbose-spork", "path": ".github/prompts/project-post.prompt.md", "ref": "a32d490928e6ae659d5e3bee2adc7b00cc2a9432", "url": "https://github.com/sharf-shawon/verbose-spork/blob/a32d490928e6ae659d5e3bee2adc7b00cc2a9432/.github/prompts/project-post.prompt.md", "key": "sharf-shawon/verbose-spork/.github/prompts/project-post.prompt.md" } } }

project-post

About