Skip to content

Move README details into docs - #35

Merged
llbbl merged 1 commit into
mainfrom
docs/trim-readme
Aug 6, 2026
Merged

Move README details into docs#35
llbbl merged 1 commit into
mainfrom
docs/trim-readme

Conversation

@llbbl

@llbbl llbbl commented Aug 6, 2026

Copy link
Copy Markdown
Owner

Summary

  • shorten the README to a lightweight project overview and quick start
  • move development and deployment guidance into dedicated docs pages linked from the README
  • stop tracking CLAUDE.md while keeping it ignored locally

Changes

Documentation

  • README.md: Reduce the top-level docs to a concise overview, quick start, and links to deeper guides
  • docs/development.md: Add a dedicated development guide with setup, commands, and pre-PR checks
  • docs/deployment.md: Add a deployment guide for the production server and Docker workflows

Repository Hygiene

  • .gitignore: Ignore CLAUDE.md so it can remain local-only
  • CLAUDE.md: Remove the tracked file from version control while preserving ignored local copies

Test plan

Closes #34

• Keep the README short and action-oriented while preserving
  development and deployment guidance in dedicated docs
• Stop tracking CLAUDE.md so local agent notes can stay on disk
  without showing up in future documentation changes
@railway-app

railway-app Bot commented Aug 6, 2026

Copy link
Copy Markdown

🚅 Deployed to the luddy.dance-pr-35 environment in superb-amazement

Service Status Web Updated (UTC)
luddy.dance ✅ Success (View Logs) Web Aug 6, 2026 at 2:54 pm

@railway-app
railway-app Bot temporarily deployed to superb-amazement / luddy.dance-pr-35 August 6, 2026 14:54 Destroyed
@llbbl
llbbl merged commit 78c8e3b into main Aug 6, 2026
8 checks passed
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.

Trim README and organize project docs

1 participant