Update to the README page #26
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for splashkit ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for splashkit ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update README
Description
This PR enhances the README documentation for the SplashKit Starlight site. The changes aim to provide clearer instructions, a more organised project structure, and updated command details to help contributors and users navigate the project effectively.
Key Updates
Expanded Project Structure: Added a detailed project structure to reflect the current file organisation, including:
scripts/folder.public/directory withgifs/,images/,resources/, andusage-examples/.arcade-hackathon-project/folder undersrc/content/docs/.Enhanced Command Table: Updated the commands section to include new scripts and their descriptions:
npm run generate-usage-examples-pages: Generates usage example pages from./scripts/usage-example-page-generation.cjs.npm run check-links: Temporarily setsCHECK_LINKS=true, runsnpm run build, then resetsCHECK_LINKS=false.Minor Language Adjustments:
Motivation
The goal of these changes is to make the README more comprehensive and user-friendly, especially for new contributors and users in preparation for Trimester 3 2024.