Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Guide for splashkit.io-starlight development #101

Merged
merged 9 commits into from
Nov 6, 2024

Conversation

NidhishaPahade
Copy link
Contributor

@NidhishaPahade NidhishaPahade commented Sep 20, 2024

Description

Created a GitHub Guide for onboarding and setting up the environment for SplashKit integrating NodeJS , VS Code and GitHub.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • Documentation (update or new)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can
reproduce. Please also list any relevant details for your test configuration.

  • Tested in latest Chrome
  • Tested in latest Firefox
  • npm run build
  • npm run preview

Checklist

If involving code

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

If modified config files

  • I have checked the following files for changes:
    • package.json
    • astro.config.mjs
    • netlify.toml
    • docker-compose.yml
    • custom.css

Folders and Files Added/Modified

Please list the folders and files added/modified with this pull request.

  • Added:
    • src/content/docs/products/splashkit/SplashKit Tutorials/Onboarding/02-GitHub-guide.mdx
  • Modified:
    • NA

Below is the preview of the guide:
Screenshot 2024-09-26 123808
Screenshot 2024-09-26 123830
Screenshot 2024-09-26 123854
Screenshot 2024-09-26 123912
Screenshot 2024-09-26 123925

Copy link

netlify bot commented Sep 20, 2024

Deploy Preview for thoth-tech ready!

Name Link
🔨 Latest commit c5f613a
🔍 Latest deploy log https://app.netlify.com/sites/thoth-tech/deploys/672acd37ca8de30008f490a7
😎 Deploy Preview https://deploy-preview-101--thoth-tech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Sep 20, 2024

Deploy Preview for strong-fairy-c1bde1 ready!

Name Link
🔨 Latest commit c5f613a
🔍 Latest deploy log https://app.netlify.com/sites/strong-fairy-c1bde1/deploys/672acd376632eb0008b916c2
😎 Deploy Preview https://deploy-preview-101--strong-fairy-c1bde1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Improved format style (just as a start) and fixed lint errors
@omckeon
Copy link
Collaborator

omckeon commented Sep 22, 2024

@NidhishaPahade Please update the PR description to use the template from this page. With screenshots put at the end.

@omckeon omckeon changed the title Guide Add GitHub Guide for splashkit.io-starlight development Sep 22, 2024
Copy link

@kay-kaushik kay-kaushik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good. The guide is well-written and nicely structured. To summarise, I suggest adding the links to these important websites and to use gifs to make the guide better.

Copy link

@kay-kaushik kay-kaushik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links have been added as suggested. The PR looks much better and it will be very helpful for new students when they onboard.

@omckeon omckeon merged commit 6eb7269 into thoth-tech:main Nov 6, 2024
6 of 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.

3 participants