Apply suggestions from CAM's code review

Co-authored-by: C.A.M. Gerlach <[email protected]>

Author: conradolandia

CONTRIBUTING.md

@@ -37,20 +37,20 @@ Thank you for your interest in contributing to the Spyder website! This guide wi
 ## Development Setup
 
 1. **Install dependencies**:
-   ```bash
+   ```shell
    npm install
    ```
 
 2. **Start the development server**:
-   ```bash
+   ```shell
    npm run dev
    ```
-   The site will be available at `http://localhost:5173`
 
-3. **Available scripts**:
-   - `npm run dev` - Start development server
-   - `npm run build` - Build for production
-   - `npm run preview` - Preview production build
+3. View the site at [http://localhost:5173](http://localhost:5173)
+**Available scripts**:
+- `npm run dev` - Start development server
+- `npm run build` - Build for production
+- `npm run preview` - Preview production build
 
 ## Types of Contributions
 
@@ -94,7 +94,7 @@ If the blog post author(s) haven't been added yet:
    ---
    ```
 
-3. **Write content** using mdsvex Markdown:
+3. **Write content** using [mdsvex](https://mdsvex.pngwn.io/) Markdown:
    - [Never indent code blocks](https://mdsvex.pngwn.io/docs#limitations)
    - Use standard Markdown syntax for formatting
    - Follow our [style guide](#style-guidelines) for consistency
@@ -108,7 +108,7 @@ If the blog post author(s) haven't been added yet:
    - Prefer WEBP format for better performance
 
 5. **Preview your post**:
-   ```bash
+   ```shell
    npm run dev
    ```
    - Verify post appears at `/blog/your-post-name`
@@ -135,8 +135,8 @@ If the blog post author(s) haven't been added yet:
 
 Before creating an issue:
 
-1. **Search existing issues** to avoid duplicates
-2. **Use the issue template** (if available)
+1. **Search [existing issues](https://github.com/spyder-ide/spyder-website/issues)** to avoid duplicates
+2. **Complete all relevant fields of the issue template**
 3. **Include relevant details**:
    - Clear description of the problem
    - Steps to reproduce
@@ -147,7 +147,7 @@ Before creating an issue:
 ## Pull Request Process
 
 1. **Ensure your changes work locally**:
-   ```bash
+   ```shell
    npm run dev
    # Test your changes thoroughly
    ```
@@ -193,7 +193,7 @@ Before creating an issue:
 
 If you have questions or need help:
 
-- Check existing [documentation](README.md)
+- Check the [documentation](./README.md)
 - Search [existing issues](https://github.com/spyder-ide/spyder-website/issues)
 - Create a new issue with the "question" label
 

README.md

@@ -29,7 +29,7 @@ This website is built with modern web technologies:
 - **Content**: [mdsvex](https://mdsvex.pngwn.io/) - Markdown processor for Svelte
 - **Icons**: [Svelte Icons Pack](https://leshak.github.io/svelte-icons-pack/) - Icon library
 - **Deployment**: [GitHub Pages](https://pages.github.com/) - Static site hosting
-- **CI/CD**: GitHub Actions - Automated deployment
+- **CI/CD**: [GitHub Actions](https://github.com/features/actions) - Automated deployment
 
 ## Features
 
@@ -49,21 +49,21 @@ This website is built with modern web technologies:
 - [Node.js](https://nodejs.org/) (version 18 or higher)
 - [npm](https://www.npmjs.com/) (comes with Node.js)
 
-### Development Setup
+### Build locally
 
 1. **Clone the repository**:
-   ```bash
+   ```shell
    git clone https://github.com/spyder-ide/spyder-website.git
    cd spyder-website
    ```
 
 2. **Install dependencies**:
-   ```bash
+   ```shell
    npm install
    ```
 
 3. **Start development server**:
-   ```bash
+   ```shell
    npm run dev
    ```
 
@@ -83,10 +83,10 @@ This website is built with modern web technologies:
 
 ## Project Structure
 
-```
+```text
 spyder-website/
 ├── src/
-│   ├── routes/                 # Page routes and content
+│   ├── routes/                # Page routes and content
 │   │   ├── +page.svelte       # Homepage
 │   │   ├── about/             # About page
 │   │   ├── blog/              # Blog posts and pages
@@ -133,33 +133,33 @@ The built site will be available at [http://localhost:5174](http://localhost:517
 
 We welcome contributions from the community! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
 
+- Reporting issues
 - Setting up the development environment
 - Creating blog posts
 - Making code contributions
 - Submitting pull requests
-- Reporting issues
 
 ### Quick Contribution Steps
 
-1. Fork this repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+1. Fork and clone this repository
+2. Create a topic branch (`git switch -c topic-branch-name-here`)
 3. Make your changes
 4. Test locally (`npm run dev`)
 5. Commit your changes (`git commit -m 'Add amazing feature'`)
-6. Push to your branch (`git push origin feature/amazing-feature`)
-7. Open a Pull Request
+6. Push your branch to your fork (`git push -u origin topic-branch-name-here`)
+7. Open a [Pull Request](https://github.com/spyder-ide/spyder-website/pull/new)
 
 ## Community
 
 - 🐍 **Main Project**: [Spyder IDE](https://github.com/spyder-ide/spyder)
 - 💬 **Discussions**: [GitHub Discussions](https://github.com/spyder-ide/spyder/discussions)
-- 🐛 **Issues**: [Bug Reports](https://github.com/spyder-ide/spyder/issues)
+- 🐛 **Issues**: [Bug Reports](https://github.com/spyder-ide/spyder-website/issues)
 - 📧 **Mailing List**: [Google Groups](https://groups.google.com/group/spyderlib)
 - 🐦 **Twitter**: [@Spyder_IDE](https://twitter.com/Spyder_IDE)
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
+This project is released under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details.
 
 ## Acknowledgments
 
@@ -168,6 +168,3 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md
 - Powered by [SvelteKit](https://kit.svelte.dev/) and [TailwindCSS](https://tailwindcss.com/)
 - Hosted on [GitHub Pages](https://pages.github.com/)
 
----
-
-*Made with love for the Python community*