Skip to content

docs: update CONTRIBUTING.md and QUICKSTART.md to match Astro stack#67

Closed
jongio wants to merge 1 commit into
mainfrom
fix/docs-stack-references
Closed

docs: update CONTRIBUTING.md and QUICKSTART.md to match Astro stack#67
jongio wants to merge 1 commit into
mainfrom
fix/docs-stack-references

Conversation

@jongio
Copy link
Copy Markdown
Owner

@jongio jongio commented May 16, 2026

Summary

CONTRIBUTING.md and QUICKSTART.md still reference the pre-migration React/Vite/Vitest stack that was replaced with Astro in PR #9. This actively misleads contributors who follow the documented setup steps.

Problems Fixed

File Issue
CONTRIBUTING.md Listed 8 non-existent npm scripts (pnpm test, pnpm lint, pnpm type-check, etc.)
CONTRIBUTING.md Referenced non-existent files (ExtensionCard.tsx, App.tsx, main.tsx, index.css)
CONTRIBUTING.md Described React coding standards (hooks, functional components) instead of Astro
CONTRIBUTING.md Project structure showed shadcn/ui, icons/, test/, types/ directories that don't exist
CONTRIBUTING.md CI workflow description said "Lint, type-check, test, build" instead of actual pipeline
QUICKSTART.md Said dependencies include "React 19, Vite, and testing tools"
QUICKSTART.md Dev server URL was localhost:5173 (Vite default) instead of localhost:4321 (Astro default)
QUICKSTART.md Listed non-existent commands (pnpm test, pnpm lint, pnpm format, etc.)
QUICKSTART.md Troubleshooting referenced "Vite" behavior instead of Astro

Changes

  • Updated development commands table to match actual package.json scripts
  • Replaced React coding standards with Astro component guidance
  • Updated "Adding a New Extension" step 6 to reference ExtensionShowcase.astro instead of ExtensionCard.tsx
  • Corrected project structure to reflect actual src/ layout
  • Fixed dev server port and dependency descriptions
  • Updated quality standards checklist to match actual CI checks

Validation

  • pnpm build passes before and after changes

Both files still referenced the pre-migration React/Vite stack:
- Non-existent npm scripts (test, lint, type-check, format)
- Wrong file paths (ExtensionCard.tsx, App.tsx, main.tsx)
- Incorrect dev server port (5173 instead of 4321)
- React-specific coding standards instead of Astro

Updated to reflect the actual Astro-based project structure,
available scripts, and component patterns.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jongio jongio added automated Created by automation pr-learn Issues and PRs from pr-learn analysis labels May 16, 2026
@jongio
Copy link
Copy Markdown
Owner Author

jongio commented May 17, 2026

Superseded by swarm PR #88. Will be re-addressed in a follow-up swarm session.

@jongio jongio closed this May 17, 2026
@jongio jongio deleted the fix/docs-stack-references branch May 17, 2026 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated Created by automation pr-learn Issues and PRs from pr-learn analysis

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant