fixed faq section and updated README.md#81
Conversation
|
@meharwanfr is attempting to deploy a commit to the Hack Club Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR addresses a visual issue in the FAQ section by adjusting the divider styling, and replaces the default Svelte README with project-specific messaging plus a short contribution guide.
Changes:
- Update the FAQ divider styling to use a fixed 1px height.
- Replace the default Svelte README with a Resolution-specific tagline and contribution steps.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
resolution-frontend/src/lib/components/InitialPage.svelte |
Tweaks FAQ divider CSS to render as a thin line. |
resolution-frontend/README.md |
Rewrites README content to be project-specific and include contribution steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Create your own fork of this repo (by clicking the fork button) | ||
| 2. Now copy the url to your forked repo and clone it using : | ||
|
|
||
| ```sh | ||
| # create a new project in the current directory | ||
| npx sv create | ||
|
|
||
| # create a new project in my-app | ||
| npx sv create my-app | ||
| git clone https://github.com/your_username_here/resolution | ||
| cd resolution/resolution-frontend | ||
| ``` |
There was a problem hiding this comment.
The ordered list formatting will likely break around the fenced code blocks because the code blocks aren’t indented under items 2/3. Indent the fenced blocks (and their contents) so steps 3 and 4 remain part of the same numbered list in GitHub Markdown rendering.
| 3. now install npm packages | ||
|
|
||
| ```sh | ||
| npm run dev | ||
|
|
||
| # or start the server and open the app in a new browser tab | ||
| npm run dev -- --open | ||
| ``` | ||
| # shorthand for : bun install | ||
| bun i | ||
|
|
||
| ## Building | ||
|
|
||
| To create a production version of your app: | ||
|
|
||
| ```sh | ||
| npm run build | ||
| # or if you have npm. | ||
| npm i | ||
| ``` | ||
|
|
||
| You can preview the production build with `npm run preview`. | ||
| 4. start coding and make your PR, yayay ! |
There was a problem hiding this comment.
The contribution instructions are missing the key commands to actually run the app (e.g., bun run dev, bun run build, tests/typecheck) and step 3 is labeled “install npm packages” even though this project is Bun-first (CI uses bun install --frozen-lockfile). Please add the run/test/build commands and prefer Bun as the primary path, with npm as an optional alternative only if it’s known to work with the repo’s lockfile expectations.
| # resolution.hackclub.com | ||
|
|
||
| Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). | ||
| Choose your challenge and ship every week. Earn prizes each week, and a giant prize if you stay til the end. |
There was a problem hiding this comment.
Minor wording: “stay til the end” is quite informal for a README; consider “stay until the end” (or similar) for clearer, more standard phrasing.
| Choose your challenge and ship every week. Earn prizes each week, and a giant prize if you stay til the end. | |
| Choose your challenge and ship every week. Earn prizes each week, and a giant prize if you stay until the end. |
i fixed the faq section's frontend by replacing
height: auto;toheight: 1px;How it was looking before
how is it looking after this commit
I updated the default svelte README.md to have a mini contribution guide and a slogan for resolution.hackclub.com.