arthur/artapi
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/artapi.git synced 2026-01-14 14:14:22 +01:00
Code Issues 3 Packages Projects Releases Wiki Activity

[PR #8] [MERGED] Refactor README to focus on portfolio API with MCP as a component #10

New Issue
Closed
opened 2025-12-17 14:22:58 +01:00 by arthur · 0 comments
arthur commented 2025-12-17 14:22:58 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/ArthurDanjou/artapi/pull/8
Author: @Copilot
Created: 12/16/2025
Status: ✅ Merged
Merged: 12/17/2025
Merged by: @ArthurDanjou

Base: master ← Head: copilot/improve-readme-file

📝 Commits (7)

  • 5504685 Initial plan
  • ad2d062 Improve README.md with badges, ToC, examples, and better documentation
  • 0a129ac Fix badge links and remove trailing whitespace
  • b2b5f3b Add wrangler login command and clarify Bun usage
  • ecd420e Refocus README on API with MCP as a component
  • 87f0b7b Delete pnpm-lock.yaml
  • 92718bf Update README to reflect Bun as primary runtime and correct D1 database usage

📊 Changes

1 file changed (+298 additions, -83 deletions)

View changed files

📝 README.md (+298 -83)

📄 Description

The README incorrectly positioned the project as an MCP server when it's actually a comprehensive portfolio API with MCP as one optional component.

Changes

Repositioning & Structure

  • Renamed from "ArtMCP - MCP Server" to "ArtAPI - Arthur Danjou's Portfolio API"
  • Repositioned as REST API-first with MCP as an optional component
  • Table of contents reorganized to prioritize API documentation
  • Added badges (Nuxt, License, Cloudflare, MCP)

API Documentation (Primary Focus)

  • Complete API endpoints documentation moved to top
  • Categorized endpoints (Profile, Experience, Real-time, Tools)
  • Added curl examples and JSON response samples
curl https://api.arthurdanjou.fr/api/profile
# Returns: { "name": "Arthur Danjou", "title": "Data Science & Applied AI Student", ... }

Architecture Section

  • Added comprehensive architecture overview
  • Explained core stack (Nuxt 4, TypeScript, Cloudflare Workers)
  • Documented data layer (Nuxt Content, Cloudflare D1, Zod)
  • Highlighted architecture benefits (fast, type-safe, scalable)

MCP Server Component (Optional Feature)

  • Created dedicated section explaining MCP as an API component
  • Connection options for MCP clients (Claude Desktop, Cline)
  • Usage examples for resources, tools, and prompts
  • Clear positioning as optional enhancement for AI assistants

Developer Experience

  • Prerequisites clarification with Bun as primary runtime (Node.js + pnpm as alternative)
  • All commands updated to use Bun (bun install, bun dev, bun preview, bun deploy, bun lint)
  • Local server URLs (web, docs, MCP endpoint)
  • Content management workflow
  • Troubleshooting section covering 6 common issues
  • Contribution guidelines with workflow and code style

Deployment

  • Added wrangler login command
  • Cloudflare authentication steps
  • Bun-based deployment workflow

The README now correctly represents ArtAPI as a comprehensive portfolio API with MCP integration as one of its features, and accurately reflects the use of Bun as the primary runtime and Cloudflare D1 as the production database.

Original prompt

Improve the readme.md

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/ArthurDanjou/artapi/pull/8 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 12/16/2025 **Status:** ✅ Merged **Merged:** 12/17/2025 **Merged by:** [@ArthurDanjou](https://github.com/ArthurDanjou) **Base:** `master` ← **Head:** `copilot/improve-readme-file` --- ### 📝 Commits (7) - [`5504685`](https://github.com/ArthurDanjou/artapi/commit/5504685480c13685fbe1b6373b1640eaec6fca5d) Initial plan - [`ad2d062`](https://github.com/ArthurDanjou/artapi/commit/ad2d06282f1f5936878df4fd335feb1b32abc426) Improve README.md with badges, ToC, examples, and better documentation - [`0a129ac`](https://github.com/ArthurDanjou/artapi/commit/0a129ace6dc24d31defdc9c3fc8c07e5f413e2f7) Fix badge links and remove trailing whitespace - [`b2b5f3b`](https://github.com/ArthurDanjou/artapi/commit/b2b5f3ba94702b883f3de9782aed918fbcd7ff84) Add wrangler login command and clarify Bun usage - [`ecd420e`](https://github.com/ArthurDanjou/artapi/commit/ecd420e511cf838e11c43d3e73ad7390b4722ead) Refocus README on API with MCP as a component - [`87f0b7b`](https://github.com/ArthurDanjou/artapi/commit/87f0b7ba6196feed1d1036f19c7dd1ba0547ed6f) Delete pnpm-lock.yaml - [`92718bf`](https://github.com/ArthurDanjou/artapi/commit/92718bfe8ebcda92cfe0d8366b2517dc5c9556e5) Update README to reflect Bun as primary runtime and correct D1 database usage ### 📊 Changes **1 file changed** (+298 additions, -83 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+298 -83) </details> ### 📄 Description The README incorrectly positioned the project as an MCP server when it's actually a comprehensive portfolio API with MCP as one optional component. ## Changes **Repositioning & Structure** - Renamed from "ArtMCP - MCP Server" to "ArtAPI - Arthur Danjou's Portfolio API" - Repositioned as REST API-first with MCP as an optional component - Table of contents reorganized to prioritize API documentation - Added badges (Nuxt, License, Cloudflare, MCP) **API Documentation (Primary Focus)** - Complete API endpoints documentation moved to top - Categorized endpoints (Profile, Experience, Real-time, Tools) - Added curl examples and JSON response samples ```bash curl https://api.arthurdanjou.fr/api/profile # Returns: { "name": "Arthur Danjou", "title": "Data Science & Applied AI Student", ... } ``` **Architecture Section** - Added comprehensive architecture overview - Explained core stack (Nuxt 4, TypeScript, Cloudflare Workers) - Documented data layer (Nuxt Content, Cloudflare D1, Zod) - Highlighted architecture benefits (fast, type-safe, scalable) **MCP Server Component (Optional Feature)** - Created dedicated section explaining MCP as an API component - Connection options for MCP clients (Claude Desktop, Cline) - Usage examples for resources, tools, and prompts - Clear positioning as optional enhancement for AI assistants **Developer Experience** - Prerequisites clarification with Bun as primary runtime (Node.js + pnpm as alternative) - All commands updated to use Bun (bun install, bun dev, bun preview, bun deploy, bun lint) - Local server URLs (web, docs, MCP endpoint) - Content management workflow - Troubleshooting section covering 6 common issues - Contribution guidelines with workflow and code style **Deployment** - Added `wrangler login` command - Cloudflare authentication steps - Bun-based deployment workflow The README now correctly represents ArtAPI as a comprehensive portfolio API with MCP integration as one of its features, and accurately reflects the use of Bun as the primary runtime and Cloudflare D1 as the production database. <!-- START COPILOT CODING AGENT SUFFIX --> <!-- START COPILOT ORIGINAL PROMPT --> <details> <summary>Original prompt</summary> > Improve the readme.md </details> <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
arthur added the pull-request label 2025-12-17 14:22:58 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
arthur
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: arthur/artapi#10
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?