Skip to content

Conversation

@TMHSDigital
Copy link
Owner

@TMHSDigital TMHSDigital commented Jul 20, 2024

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.

  • New Features:
    • Added new pages for 'Languages', 'APIs', and 'Tools' dropdowns with corresponding HTML files.
    • Introduced new documentation for 'Liquid' language including installation, setup, and introduction guides.
    • Created a template HTML file for new languages with a standard structure.
  • Enhancements:
    • Updated the master stylesheet to improve general styling and layout consistency across the site.
    • Refactored the index.html to use Jekyll templating for better maintainability and dynamic content generation.
  • Build:
    • Configured Jekyll settings in deploy.yml including theme, plugins, and social links.
  • Documentation:
    • Added README.md files for 'Liquid' language installation and introduction.
    • Added a README.md file for the 'TEMPLATE' language introduction.
  • Chores:
    • Deleted obsolete CSS and HTML files related to sections and technologies that are no longer in use.

REFORMAT/RENAME "chapter-[#]" to "[languagename]-lang"
@TMHSDigital TMHSDigital self-assigned this Jul 20, 2024
@sourcery-ai
Copy link

sourcery-ai bot commented Jul 20, 2024

Reviewer's Guide by Sourcery

This 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

Files Changes
Languages/liquid-lang/02_Liquid_Installation_and_Setup/README.md
Languages/liquid-lang/01_Introduction_to_Liquid/README.md
Languages/liquid-lang/liquid-lang.html
Added new content and structure for Liquid language including installation, introduction, and basic HTML.
pages-html/apis-dropdown.html
pages-html/languages-dropdown.html
pages-html/tools-dropdown.html
Added dropdown menu HTML files for APIs, languages, and tools.
Devicon-index/index.html
sections-css/powered-by.css
sections-css/tools.css
site-styles.css
sections-css/apis.css
sections-css/languages.css
sections-css/site-styles.css
sections-css/chapter-styles.css
sections-html/main-technologies-used.html
sections-html/languages.html
Languages/chapter-styles.css
sections-html/tools.html
sections-html/powered-by.html
Devicon-index/devicon-index.css
sections-html/apis.html
Deleted obsolete HTML and CSS files.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@TMHSDigital TMHSDigital merged commit 4d7fb30 into main Jul 20, 2024
@TMHSDigital TMHSDigital deleted the jekyll-version branch July 20, 2024 05:44
Copy link

@sourcery-ai sourcery-ai bot left a 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:

  • Hard-coded LinkedIn URL found. (link)
  • Hard-coded Twitter URL found. (link)
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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Comment on lines +25 to +34
<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>
Copy link

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.

Comment on lines +17 to +26
<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>
Copy link

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!"
```
Copy link

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.

Comment on lines +13 to +16
\```template
// Your first TEMPLATE program
print("Hello, World!")
\```
Copy link

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
Copy link

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
Copy link

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.

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.

2 participants