[WIP] Create complete GitHub project documentation setup

[Copilot]

Complete GitHub Project Documentation Generator

Plan Checklist:

• 1. Create comprehensive README.md with all required sections
  • Add centered badges section with dynamic repo info
  • Add description, links, and table of contents
  • Add installation and usage sections
  • Add features section
  • Add folder structure
  • Add tech stack with badges (languages, frameworks, databases, tools)
  • Add dependencies & packages section with version badges
  • Add contributing, license, security, and code of conduct links
  • Add footer with maintainer info
• 2. Create LICENSE file (MIT License) - file doesn't exist
• 3. Skip CONTRIBUTING.md - already exists
• 4. Skip SECURITY.md - already exists
• 5. Create CODE_OF_CONDUCT.md - file doesn't exist
• 6. Create .github directory structure
• 7. Create issue templates (YAML Issue Forms)
  • bug_report.yml
  • feature_request.yml
  • config.yml
• 8. Create pull request template
  • .github/pull_request_template.md
• 9. Verify and test all generated documentation

Original prompt

📄 Complete GitHub Project Documentation Generator (Ultimate Prompt)

You are tasked with generating a complete and professional documentation setup for ANY GitHub repository I provide.

Global rule for existing files:

• Do not overwrite existing files. If a target file already exists in the repository (in the root or .github directory), leave it as-is and only create the missing ones.
• This skip-existing rule applies to: LICENSE, CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, issue templates, and the pull request template.

Your output must include:

---

1️⃣ README.md

The README must follow this exact structure and style:

• Project Title (use repo name dynamically).

• Badges Section (centered at the top). Use Shields.io dynamically with repo details:

md

• Short Project Description (auto from repo metadata).

• 🔗 Links Section (Demo / Docs / Issues / Contributing).

• 📑 Table of Contents.

• 🚀 Installation (prerequisites + setup steps).

• ⚡ Usage Examples (CLI / API / UI depending on repo type).

• ✨ Features.

• 📂 Folder Structure (auto-generated from repo).

• 📦 Submodules Section

  • If the repo includes Git submodules / sub repos, list them explicitly with links and short descriptions.

  • Example:

    md

    📦 Submodules

    • auth-service → Handles authentication & JWT.
    • ui-library → Shared React component library.

• 🤝 Contributing → link to CONTRIBUTING.md.

• 📜 License → link to LICENSE.

• 🛡 Security → link to SECURITY.md.

• 📏 Code of Conduct → link to CODE_OF_CONDUCT.md.

• 🛠 Tech Stack:

  • Auto-detect frameworks, libraries, languages, databases, tools, services.

  • Represent each with a Shields.io badge:

    md
    

  • Group into categories:

    • Languages
    • Frameworks & Libraries
    • Databases
    • DevOps / CI / Tools
    • Cloud / Hosting

• 📦 Dependencies & Packages:

  • Auto-detect and list ALL project dependencies used in this repository, similar to the Tech Stack, displayed as badges (“boxes”). Include package names and their current versions where possible.
  • Clearly separate:
    • Runtime Dependencies
    • Dev Dependencies
    • Peer/Optional Dependencies (if applicable)
  • Detection sources by ecosystem:
    • Node.js: package.json (dependencies, devDependencies, peerDependencies, optionalDependencies), plus lockfiles (package-lock.json, yarn.lock, pnpm-lock.yaml).
    • Python: requirements.txt, requirements/*.txt, pyproject.toml (Poetry/PEP 621), poetry.lock, setup.cfg, setup.py, Pipfile, Pipfile.lock.
    • Java: pom.xml (Maven), build.gradle / build.gradle.kts (Gradle), gradle.lockfile.
    • .NET: .csproj/.fsproj, Directory.Packages.props, packages....

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.