Skip to content

docs: replace boilerplate README with project-specific content and add banner SVG#32

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-with-svg
Draft

docs: replace boilerplate README with project-specific content and add banner SVG#32
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-with-svg

Conversation

Copy link
Contributor

Copilot AI commented Mar 3, 2026

The README was still the default Next.js scaffold copy with no information about what the project actually does.

public/banner.svg

New dark-themed 900×240 banner embedding:

  • App icon (pink gradient "T")
  • Title + format badges: .xcloc .po .srt .vtt .md .docx .html
  • Tech stack callout (Next.js 16, Vercel AI SDK, Drizzle + Turso)

README.md

Full rewrite covering:

  • What it is — one-line description at the top, banner embedded
  • Features — multi-format support, AI translation, glossary, version history, cloud projects, i18n
  • Tech stack table — framework, AI, DB, auth, styling, package manager
  • Getting started — prerequisites, bun installdb:pushdev, env vars table
  • Scripts reference — all bun run * commands with descriptions
  • Project structure — annotated directory tree for the translation engine and supporting layers
  • Docs links — architecture, interface reference, upload flow, adding a format

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@vercel
Copy link

vercel bot commented Mar 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
universal-translation Ready Ready Preview, Comment Mar 3, 2026 8:57am

Request Review

@autopilot-project-manager autopilot-project-manager bot added the documentation Improvements or additions to documentation label Mar 3, 2026
@autopilot-project-manager autopilot-project-manager bot added the enhancement New feature or request label Mar 3, 2026
Co-authored-by: sirily11 <32106111+sirily11@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to include SVG file docs: replace boilerplate README with project-specific content and add banner SVG Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants