-
Notifications
You must be signed in to change notification settings - Fork 0
Jekyll version #10
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
Jekyll version #10
Conversation
REFORMAT/RENAME "chapter-[#]" to "[languagename]-lang"
…hon.html" etc. ADD FOLDER FOR LIQUID-LANG
Reviewer's Guide by SourceryThis pull request includes significant updates to the educational repository. The master-styles.css file has been overhauled to improve general styles and layout. The deployment workflow has been updated to include Jekyll settings. Several new content files have been added for the Liquid language, and dropdown menus for APIs, languages, and tools have been introduced. Obsolete HTML and CSS files have been removed to streamline the project. File-Level Changes
Tips
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @TMHSDigital - I've reviewed your changes and found some issues that need to be addressed.
Blocking issues:
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🔴 Security: 2 blocking issues
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| <li><a href="cpp-lang/index.html">C++</a></li> | ||
| <li><a href="csharp-lang/index.html">C#</a></li> | ||
| <li><a href="css-lang/index.html">CSS</a></li> | ||
| <li><a href="go-lang/index.html">Go</a></li> | ||
| <li><a href="java-lang/index.html">Java</a></li> | ||
| <li><a href="javascript-lang/index.html">JavaScript</a></li> | ||
| <li><a href="kotlin-lang/index.html">Kotlin</a></li> | ||
| <li><a href="liquid-lang/index.html">Liquid</a></li> | ||
| <li><a href="lua-lang/index.html">Lua</a></li> | ||
| <li><a href="python-lang/index.html">Python</a></li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: Consider alphabetizing the list of languages
Alphabetizing the list of languages can improve user experience by making it easier to find a specific language.
| <li><a href="../API/Blockchain/index.html" class="btn">Blockchain</a></li> | ||
| <li><a href="../API/Books/index.html" class="btn">Books</a></li> | ||
| <li><a href="../API/CurrencyExchange/index.html" class="btn">Currency Exchange</a></li> | ||
| <li><a href="../API/Finance/index.html" class="btn">Finance</a></li> | ||
| <li><a href="../API/Geolocation/index.html" class="btn">Geolocation</a></li> | ||
| <li><a href="../API/Jokes/index.html" class="btn">Jokes</a></li> | ||
| <li><a href="../API/MachineLearning/index.html" class="btn">Machine Learning</a></li> | ||
| <li><a href="../API/Movies/index.html" class="btn">Movies</a></li> | ||
| <li><a href="../API/Music/index.html" class="btn">Music</a></li> | ||
| <li><a href="../API/News/index.html" class="btn">News</a></li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: Consider using a consistent naming convention for API links
Some API links use camel case (e.g., CurrencyExchange) while others use title case (e.g., Blockchain). Consistent naming conventions can improve readability.
| output = template.render('name' => 'World') | ||
| puts output # => "Hello, World!" | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (documentation): Duplicated content detected.
The content from the beginning of the file is duplicated starting from the 'EOF' line. Please remove the duplicate content to avoid confusion.
| \```template | ||
| // Your first TEMPLATE program | ||
| print("Hello, World!") | ||
| \``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (documentation): Incorrect code block formatting.
The code block for the example is not properly formatted. Please replace '```' with '```' to correct the formatting.
| # Social links | ||
| social: | ||
| github: https://github.com/TMHSDigital | ||
| linkedin: https://www.linkedin.com/in/thomasmathes1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚨 issue (security): Hard-coded LinkedIn URL found.
Consider using an environment variable or configuration file to store this URL.
| social: | ||
| github: https://github.com/TMHSDigital | ||
| linkedin: https://www.linkedin.com/in/thomasmathes1 | ||
| twitter: https://twitter.com/your_twitter_handle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚨 issue (security): Hard-coded Twitter URL found.
Consider using an environment variable or configuration file to store this URL.
Summary by Sourcery
This pull request introduces new documentation and pages for various programming languages, tools, and APIs. It enhances the site's styling and layout, refactors the index page to use Jekyll templating, and updates the build configuration for Jekyll. Additionally, it removes outdated files to streamline the project.