Skip to content

docs: improve developer setup guide#27

Open
beanscg wants to merge 1 commit into
Keylab-dev:mainfrom
beanscg:bean-labs-keylab-setup-docs
Open

docs: improve developer setup guide#27
beanscg wants to merge 1 commit into
Keylab-dev:mainfrom
beanscg:bean-labs-keylab-setup-docs

Conversation

@beanscg

@beanscg beanscg commented Jun 8, 2026

Copy link
Copy Markdown

Fixes #16.

This makes the developer setup path more complete and easier to verify for new contributors.

Changes:

  • Correct the clone URL and local directory name to match this repository.
  • Add Node/npm/Git prerequisites.
  • Document the local development, lint, build, and production-start commands.
  • Add a short architecture overview for the Next.js app structure.
  • Expand the pull-request checklist in CONTRIBUTING.md to include lint/build validation and manual test notes.

Validation:

  • npm install completed.
  • npm run build passed.
  • Direct content check confirmed the updated setup commands and architecture overview.
  • git diff --check

Note: npm run lint was attempted and failed on existing source issues unrelated to this docs change:

  • src/types/keyboard.ts: @typescript-eslint/no-explicit-any
  • unused variable warnings in src/app/page.tsx and src/components/KeycodePicker.tsx

@vercel

vercel Bot commented Jun 8, 2026

Copy link
Copy Markdown

@beanscg is attempting to deploy a commit to the Ava Consult Team on Vercel.

A member of the Team first needs to authorize it.

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.

Improve developer setup documentation

1 participant