Skip to content

Refactor documentation for spec-driven development; update project br…#4

Merged
seiggy merged 6 commits intomainfrom
spec-driven-dev-updates
Aug 28, 2025
Merged

Refactor documentation for spec-driven development; update project br…#4
seiggy merged 6 commits intomainfrom
spec-driven-dev-updates

Conversation

@seiggy
Copy link
Copy Markdown
Collaborator

@seiggy seiggy commented Aug 6, 2025

This pull request updates the documentation and onboarding instructions across the project to shift terminology and configuration from "ConPort MCP" to "Memory MCP," streamline the setup process, and modernize the workflow for spec-driven development. It removes outdated references, simplifies Docker and local setup instructions, and updates project briefs to better align with current tools and practices.

Key changes include:

MCP Server Naming and Configuration Updates:

  • Replaces all references to "ConPort MCP" with "Memory MCP" in setup guides for .NET, Java, and Python, reflecting the new naming and purpose of the persistent memory service. [1] [2]
  • Updates configuration instructions to refer to "MCP tools" and provides links to Docker documentation for each tool (Context7, Playwright MCP, Sequential Thinking MCP, Memory MCP), removing references to running ConPort via Python/uv and streamlining Docker-based workflows. [1] [2]

Onboarding and Workflow Improvements:

  • Replaces the manual step of copying a projectBrief.md with an automated /analyze-product workflow that generates the necessary documentation and .docs folder, making the onboarding process more automated and less error-prone. [1] [2]
  • Updates the Copilot integration steps to clarify that copilot-instructions.md and other documentation are now generated by the framework, not manually managed. [1] [2]

Documentation Cleanup:

  • Removes the outdated conportal-python.md file and references to running ConPort locally, as the new workflow standardizes on Docker and the Memory MCP.
  • Deletes obsolete project brief files for both .NET (goals/dotnet/projectBrief.md) and Java (goals/java/projectBrief.md), as these are now auto-generated. [1] [2]

General Terminology and Branding:

  • Updates the main README.md to refer to "Spec Driven Development Programming Challenge" and reflects the repository's new name and focus.

These changes collectively modernize the onboarding and documentation to match the current architecture and best practices for spec-driven development with AI-assisted tools.…ief references and remove obsolete files

Copilot AI review requested due to automatic review settings August 6, 2025 14:46

This comment was marked as outdated.

@seiggy seiggy requested a review from ChrisMcKee1 August 6, 2025 14:48
seiggy and others added 5 commits August 6, 2025 10:48
@seiggy seiggy requested a review from Copilot August 28, 2025 17:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates the documentation and onboarding instructions across the project to shift terminology and configuration from "ConPort MCP" to "Memory MCP," streamline the setup process, and modernize the workflow for spec-driven development. The changes remove outdated references, simplify Docker and local setup instructions, and update project briefs to better align with current tools and practices.

  • Replaces "ConPort MCP" references with "Memory MCP" and updates MCP tool configuration
  • Introduces automated /analyze-product workflow to replace manual projectBrief.md copying
  • Updates command workflows from file-based (Plan #feature-[name].md) to slash commands (/create-spec, /execute-tasks)

Reviewed Changes

Copilot reviewed 16 out of 17 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
requirements-template.md Adds new comprehensive requirements template with structured sections for business value, technical design, and implementation planning
goals/*/projectBrief.md Removes obsolete project brief files that are now auto-generated
goals/*/1-setup.md Updates setup instructions to use Memory MCP, removes ConPort references, and introduces /analyze-product workflow
goals/*/2-requirements.md Replaces manual requirements template with /create-spec command and updates workflow commands
goals/3-tips.md Updates workflow tips to reference new slash commands instead of old file-based commands
conportal-python.md Removes obsolete ConPort Python setup documentation
README.md Updates project title to "Spec Driven Development Programming Challenge" and refreshes repository references

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread goals/java/2-requirements.md
Comment thread goals/java/1-setup.md
Comment thread goals/typescript/1-setup.md
Comment thread goals/python/1-setup.md
@seiggy seiggy merged commit 9bddad2 into main Aug 28, 2025
1 check passed
@seiggy seiggy deleted the spec-driven-dev-updates branch August 28, 2025 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants