[PR #14] Enhance README with development setup and security documentation #18

New Issue

arthur · 2026-02-27T16:50:52+01:00

arthur commented

2026-02-27 16:50:52 +01:00

Original Pull Request: https://github.com/ArthurDanjou/artsite/pull/14

State: closed
Merged: Yes

Plan: Improve README.md

Analysis

The current README is decent but missing crucial sections for developers wanting to contribute or run the project locally.

Improvements Made

Add Prerequisites section (Node.js version, package manager)
Add Getting Started/Installation section with setup steps
Add Development section with all available npm scripts
Add Environment Variables section documenting required vars
Enhance Project Structure with more detail about key directories
Add Contributing guidelines section
Add Deployment section with deployment instructions
Add helpful badges and quick links (Live Demo, Report Bug)
Update Tech Stack to reflect actual package manager (Bun, not pnpm)
Add Cloudflare D1 database to Tech Stack
Keep all existing good content intact
Add security warnings for all sensitive environment variables
Use clear placeholder values in environment variable examples
Remove generic documentation link (keeping only project-specific links)
Remove useless environment variables (NUXT_PUBLIC_I18N_BASE_URL, NUXT_API_URL, NUXT_DISCORD_ID)
Fix project structure documentation to match actual directory layout (app.config.ts location, remove non-existent layouts/, add server/routes/)
Expand content section to show all individual markdown and JSON files (28 files total across education, experiences, projects, and root level)

Original prompt

Improve readme.md

💡 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.

Note

Scope: Documentation-only update to README.md enhancing developer onboarding and deployment clarity.

Adds sections: Prerequisites, Getting Started, Development (scripts), Environment Variables (with security notes), Deployment, and Contributing

Updates Tech Stack: NuxtHub on Cloudflare, switches package manager to Bun, adds Cloudflare D1 database

Expands Project Structure with detailed directories under app/, content/, server/, and config files

Provides Cloudflare deployment steps (bun run deploy) and notes on automatic deployments via NuxtHub

Adds badges/links (Cloudflare badge, Live Demo, Report Bug)

Keeps existing features/integrations while clarifying Integrations list

^{Written by Cursor Bugbot for commit 4d520797c9. This will update automatically on new commits. Configure here.}

**Original Pull Request:** https://github.com/ArthurDanjou/artsite/pull/14 **State:** closed **Merged:** Yes --- ## Plan: Improve README.md ### Analysis The current README is decent but missing crucial sections for developers wanting to contribute or run the project locally. ### Improvements Made - [x] Add Prerequisites section (Node.js version, package manager) - [x] Add Getting Started/Installation section with setup steps - [x] Add Development section with all available npm scripts - [x] Add Environment Variables section documenting required vars - [x] Enhance Project Structure with more detail about key directories - [x] Add Contributing guidelines section - [x] Add Deployment section with deployment instructions - [x] Add helpful badges and quick links (Live Demo, Report Bug) - [x] Update Tech Stack to reflect actual package manager (Bun, not pnpm) - [x] Add Cloudflare D1 database to Tech Stack - [x] Keep all existing good content intact - [x] Add security warnings for all sensitive environment variables - [x] Use clear placeholder values in environment variable examples - [x] Remove generic documentation link (keeping only project-specific links) - [x] Remove useless environment variables (NUXT_PUBLIC_I18N_BASE_URL, NUXT_API_URL, NUXT_DISCORD_ID) - [x] Fix project structure documentation to match actual directory layout (app.config.ts location, remove non-existent layouts/, add server/routes/) - [x] Expand content section to show all individual markdown and JSON files (28 files total across education, experiences, projects, and root level)   <details> <summary>Original prompt</summary> > Improve readme.md </details>  --- 💡 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](https://gh.io/copilot-coding-agent-tips) in the docs.  --- > [!NOTE] > **Scope:** Documentation-only update to `README.md` enhancing developer onboarding and deployment clarity. > > - Adds sections: `Prerequisites`, `Getting Started`, `Development` (scripts), `Environment Variables` (with security notes), `Deployment`, and `Contributing` > - Updates Tech Stack: `NuxtHub` on Cloudflare, switches package manager to `Bun`, adds `Cloudflare D1` database > - Expands `Project Structure` with detailed directories under `app/`, `content/`, `server/`, and config files > - Provides Cloudflare deployment steps (`bun run deploy`) and notes on automatic deployments via NuxtHub > - Adds badges/links (Cloudflare badge, Live Demo, Report Bug) > - Keeps existing features/integrations while clarifying `Integrations` list > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 4d520797c99bd3e7ad9189c5d63d06d283f756b6. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>

arthur added the pull-request label 2026-02-27 16:50:52 +01:00

arthur closed this issue

2026-02-27 16:50:53 +01:00

arthur referenced this issue

2026-02-27 16:50:54 +01:00

[PR #18] [CLOSED] [WIP] Update Markdown files with standard structure #21

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: arthur/artsite#18