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

Inserting and updating links to tutorials #1270

Open
wants to merge 25 commits into
base: master
Choose a base branch
from

Conversation

FabriLluvia
Copy link

@FabriLluvia FabriLluvia commented Oct 20, 2024

Solves #1079, #1082, #918, #780, #1133, #1022, #1018, #1016, #1015 and #998

Summary by CodeRabbit

  • Documentation
    • Enhanced the README with new curated tutorial links covering topics such as 3D rendering, database development, operating system creation, 8-bit computer building, error-correction in Python, and React Native TV app development.

@FabriLluvia FabriLluvia changed the title Insert "How to build your first error-correction code in vanilla Python" Inserting and updating links to tutorials Oct 20, 2024
@FabriLluvia FabriLluvia mentioned this pull request Oct 21, 2024
26 tasks
@anmolchhabra21
Copy link

Since you compiled it only 5 days ago,
Please have a look at #1271

@noam-no
Copy link

noam-no commented Nov 28, 2024

It's been a month without news, I made a PR fixing #1271, I've checked the new links of this PR and they are still relevant, we should merge the current changes here.

@FabriLluvia
Copy link
Author

Sorry, guys and girls. I'll check everything, some stuff happened, I had to work on another proyect, but now I am here.

FabriLluvia and others added 3 commits November 29, 2024 19:17
Closes codecrafters-io#1279, which had not all the three parts in the PR

Co-Authored-By: trenki2 <[email protected]>
Solves codecrafters-io#415, which had two mistakes, like:
1) Not containing Proggramimg Language
2) Not having a link

Co-Authored-By: Rushil <[email protected]>
Co-Authored-By: Santiago Degetau <[email protected]>
@FabriLluvia
Copy link
Author

Closes #1285

…tion, see..." section down of "Build your own Operating System", due to request in codecrafters-io#1283
Copy link

coderabbitai bot commented Feb 16, 2025

Warning

Rate limit exceeded

@FabriLluvia has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 24 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 136dbdf and c7da129.

📒 Files selected for processing (1)
  • README.md (9 hunks)

Walkthrough

The README file was updated to include additional tutorial links across several sections. New resources were added for building a 3D Renderer with a four-part C++ series, constructing a NoSQL database using Go, learning operating system development with OSDev references and a C-based tutorial, and exploring various topics under Uncategorized including an 8-bit computer project, Python error-correction code, and a React Native TV app guide.

Changes

File Change Summary
README.md Added multiple tutorial links under:
Build your own 3D Renderer - 4 C++ tutorial parts
Build your own Database - 1 Go-based NoSQL tutorial
Build your own Operating System - OSDev references and a C OS-build playlist
Uncategorized - Tutorials for building an 8-bit computer, Python error-correction code, and a React Native TV app

Poem

I'm a hoppy rabbit with a coding beat,
Nibbling links that make our docs complete.
C++, Go, and Python join in a merry tune,
Helping builders from dawn till noon.
With React Native hops and OS dev dreams,
Our README blossoms in vibrant gleams!
🐰💻✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@FabriLluvia FabriLluvia mentioned this pull request Feb 16, 2025
26 tasks
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (7)
README.md (7)

49-52: Maintain Consistent Markdown Emphasis Formatting
The four newly added C++ Software Renderer tutorial links use underscores for emphasizing the tutorial titles. For consistency with the rest of the document—and to satisfy markdownlint’s MD049 rule—it’s recommended to replace the underscores with asterisks.

-* [**C++**: _Developing a Software Renderer (Part 1)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part1/)
+* [**C++**: *Developing a Software Renderer (Part 1)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part1/)

-* [**C++**: _Developing a Software Renderer (Part 2)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part2/)
+* [**C++**: *Developing a Software Renderer (Part 2)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part2/)

-* [**C++**: _Developing a Software Renderer (Part 3)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part3/)
+* [**C++**: *Developing a Software Renderer (Part 3)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part3/)

-* [**C++**: _Developing a Software Renderer (Part 4)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part4/)
+* [**C++**: *Developing a Software Renderer (Part 4)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part4/)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


112-112: Standardize Markdown Emphasis in Bot Tutorial Link
The added Python Reddit Bot tutorial link uses underscores for emphasis. Replacing these with asterisks will ensure consistent formatting throughout the README and address markdownlint MD049 warnings.

-* [**Python**: _Build a Reddit Bot_](https://new.pythonforengineers.com/blog/build-a-reddit-bot-part-1)
+* [**Python**: *Build a Reddit Bot*](https://new.pythonforengineers.com/blog/build-a-reddit-bot-part-1)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

112-112: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


112-112: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Consistent Emphasis for Go Tutorial Link
The new Go tutorial link for “Build a NoSQL Database From Scratch in 1000 Lines of Code using Go” also uses underscores for emphasis. For consistency and to meet markdownlint MD049 standards, please change the underscores to asterisks.

-* [**Go**: _Build a NoSQL Database From Scratch in 1000 Lines of Code using Go_](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924)
+* [**Go**: *Build a NoSQL Database From Scratch in 1000 Lines of Code using Go*](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924)
🧰 Tools
🪛 LanguageTool

[duplication] ~139-~139: Possible typo: you repeated a word.
Context: ...rom Scratch in 1000 Lines of Code using Go_](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924) * [Go: _Build Your Own Database from Scratc...

(ENGLISH_WORD_REPEAT_RULE)

🪛 markdownlint-cli2 (0.17.2)

139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Reconsider Emphasis Usage for OSDev Reference
The line

_For more general information, see OSDev.org and OSDev.wiki_

is currently styled with emphasis. Since this is an informational note in the Operating System section, consider using plain text or a heading instead to improve clarity and address markdownlint’s MD036 warning about using emphasis as a heading substitute.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

263-263: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Standardize Markdown Emphasis in OS Tutorial Link
The newly added “Building an OS” tutorial link uses underscores for emphasis in its title, which is inconsistent with the rest of the document. Please change the underscores to asterisks to align with markdownlint MD049 requirements.

-* [**C**: _Building an OS_](https://www.youtube.com/playlist?list=PLFjM7v6KGMpiH2G-kT781ByCNC_0pKpPN)
+* [**C**: *Building an OS*](https://www.youtube.com/playlist?list=PLFjM7v6KGMpiH2G-kT781ByCNC_0pKpPN)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Ensure Consistent Emphasis in 8-Bit Computer Tutorial
The new 8-bit computer tutorial link in the Uncategorized section uses underscores for emphasis. For consistency with the rest of the document and to satisfy markdownlint MD049, please replace the underscores with asterisks.

-* [**C**: _Build an 8-bit computer from Scratch_](https://eater.net/8bit)
+* [**C**: *Build an 8-bit computer from Scratch*](https://eater.net/8bit)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


484-484: Remove Extraneous Spaces in React Native Link Text
The React Native TV app tutorial link contains extra spaces within the link text (notice the trailing space after “TV app”). Removing these will clean up the formatting and address markdownlint MD039 regarding spaces inside link text.

-* [**React Native**: Build your own TV app ](https://github.com/AmazonAppDev/react-native-multi-tv-app-sample)
+* [**React Native**: *Build your own TV app*](https://github.com/AmazonAppDev/react-native-multi-tv-app-sample)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

484-484: Spaces inside link text
null

(MD039, no-space-in-links)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b7d32b and 54ce764.

📒 Files selected for processing (1)
  • README.md (7 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


112-112: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


112-112: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


265-265: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


265-265: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


266-266: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


266-266: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


267-267: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


267-267: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


269-269: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


269-269: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


270-270: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


270-270: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


271-271: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


271-271: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


272-272: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


272-272: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


273-273: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


273-273: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


274-274: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


274-274: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


275-275: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


275-275: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


276-276: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


276-276: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


477-477: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


477-477: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


478-478: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


478-478: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


479-479: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


479-479: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


480-480: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


480-480: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


481-481: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


481-481: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


482-482: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


482-482: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


483-483: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


483-483: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


484-484: Spaces inside link text
null

(MD039, no-space-in-links)

🪛 LanguageTool
README.md

[duplication] ~139-~139: Possible typo: you repeated a word.
Context: ...rom Scratch in 1000 Lines of Code using Go_](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924) * [Go: _Build Your Own Database from Scratc...

(ENGLISH_WORD_REPEAT_RULE)


[misspelling] ~274-~274: This word is normally spelled as one.
Context: ...th-keyboard) * [C: Build a minimal multi-tasking kernel for ARM from scratch](https://g...

(EN_COMPOUNDS_MULTI_TASKING)


[uncategorized] ~478-~478: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...wsbe/) * [Ruby: A Pedometer in the Real World](http://aosabook.org/en/500L/a-pedomet...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[duplication] ~480-~480: Possible typo: you repeated a word.
Context: ... * Rust: Building a DNS server in Rust * [Rust: _Writing Scalable Chat Service from ...

(ENGLISH_WORD_REPEAT_RULE)

README.md Outdated
@@ -455,6 +464,7 @@ It's a great way to learn.
* [**PHP**: _Code a Web Search Engine in PHP_](https://boyter.org/2013/01/code-for-a-search-engine-in-php-part-1/)
* [**Python**: _Build a Deep Learning Library_](https://www.youtube.com/watch?v=o64FV-ez6Gw) [video]
* [**Python**: _How to Build a Kick-Ass Mobile Document Scanner in Just 5 Minutes_](https://www.pyimagesearch.com/2014/09/01/build-kick-ass-mobile-document-scanner-just-5-minutes/)
* [**Python**: _How to build your first error-correction code in vanilla Python][(http://aosabook.org/en/500L/a-continuous-integration-system.html](https://quantum-for-the-confused.medium.com/building-your-first-error-correction-code-in-python-4c1da6d56876))
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix Malformed Markdown Link for Python Error-Correction Tutorial
The link for the Python error-correction tutorial appears malformed and mixes bracket notations. It is currently rendered as:

[**Python**: _How to build your first error-correction code in vanilla Python][(http://aosabook.org/en/500L/a-continuous-integration-system.html](https://quantum-for-the-confused.medium.com/building-your-first-error-correction-code-in-python-4c1da6d56876))

To fix this, please simplify it to a standard markdown link. For example:

[**Python**: *How to build your first error-correction code in vanilla Python*](https://quantum-for-the-confused.medium.com/building-your-first-error-correction-code-in-python-4c1da6d56876)

This change will resolve the formatting issue and improve readability.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (7)
README.md (7)

49-52: Standardize Markdown Emphasis Style in Renderer Tutorials

The four new links for the “Developing a Software Renderer” series use underscores for italic emphasis. Markdownlint (MD049) recommends using asterisks instead for consistency. Please update the formatting as shown below:

-* [**C++**: _Developing a Software Renderer (Part 1)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part1/)
-* [**C++**: _Developing a Software Renderer (Part 2)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part2/)
-* [**C++**: _Developing a Software Renderer (Part 3)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part3/)
-* [**C++**: _Developing a Software Renderer (Part 4)_](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part4/)
+* [**C++**: *Developing a Software Renderer (Part 1)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part1/)
+* [**C++**: *Developing a Software Renderer (Part 2)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part2/)
+* [**C++**: *Developing a Software Renderer (Part 3)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part3/)
+* [**C++**: *Developing a Software Renderer (Part 4)*](https://trenki2.github.io/blog/2017/06/06/developing-a-software-renderer-part4/)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Consistent Emphasis Formatting in Go Tutorial Link

The new Go tutorial link for building a NoSQL database currently uses underscores for emphasis. For a consistent look across the document, please replace the underscores with asterisks:

-* [**Go**: _Build a NoSQL Database From Scratch in 1000 Lines of Code using Go_](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924)
+* [**Go**: *Build a NoSQL Database From Scratch in 1000 Lines of Code using Go*](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924)
🧰 Tools
🪛 LanguageTool

[duplication] ~139-~139: Possible typo: you repeated a word.
Context: ...rom Scratch in 1000 Lines of Code using Go_](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924) * [Go: _Build Your Own Database from Scratc...

(ENGLISH_WORD_REPEAT_RULE)

🪛 markdownlint-cli2 (0.17.2)

139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Refine OS Development Section Intro Text

The italicized note in the Operating System section—currently written as
_For more general information, see OSDev.org and OSDev.wiki_—could be made clearer by removing the unnecessary emphasis. This change will also address markdownlint MD049 warnings:

-_For more general information, see OSDev.org and OSDev.wiki_
+For more general information, see OSDev.org and OSDev.wiki.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

263-263: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Update Emphasis for OS Tutorial Link

The new link for “Building an OS” uses underscores for the italic text. To maintain consistency with the rest of the document, please convert the underscores to asterisks:

-* [**C**: _Building an OS_](https://www.youtube.com/playlist?list=PLFjM7v6KGMpiH2G-kT781ByCNC_0pKpPN)
+* [**C**: *Building an OS*](https://www.youtube.com/playlist?list=PLFjM7v6KGMpiH2G-kT781ByCNC_0pKpPN)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Consistent Formatting in 8-bit Computer Tutorial Link

In the Uncategorized section, the link for “Build an 8-bit computer from Scratch” is formatted with underscores for emphasis. For consistency, please update it to use asterisks:

-* [**C**: _Build an 8-bit computer from Scratch_](https://eater.net/8bit)
+* [**C**: *Build an 8-bit computer from Scratch*](https://eater.net/8bit)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


477-477: Standardize Emphasis for Python Tutorial Link

The link for “Windowing Systems by Example” in the Uncategorized section uses underscores for italic formatting. For stylistic and consistency reasons, please update it as follows:

-* [**Python**: _Windowing Systems by Example_](https://jmarlin.github.io/wsbe/)
+* [**Python**: *Windowing Systems by Example*](https://jmarlin.github.io/wsbe/)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

477-477: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


477-477: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


483-484: Align Emphasis Style and Clean Up Link Text in Final Tutorial Links

For the TypeScript tutorial link, replace underscores with asterisks. Also, remove the extra trailing space in the React Native link to clean up the presentation:

-* [**TypeScript**: _Tiny Package Manager: Learns how npm or Yarn works_](https://github.com/g-plane/tiny-package-manager)
+* [**TypeScript**: *Tiny Package Manager: Learns how npm or Yarn works*](https://github.com/g-plane/tiny-package-manager)

-* [**React Native**: Build your own TV app ](https://github.com/AmazonAppDev/react-native-multi-tv-app-sample)
+* [**React Native**: Build your own TV app](https://github.com/AmazonAppDev/react-native-multi-tv-app-sample)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

483-483: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


483-483: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


484-484: Spaces inside link text
null

(MD039, no-space-in-links)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54ce764 and 136dbdf.

📒 Files selected for processing (1)
  • README.md (7 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


49-49: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


50-50: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


51-51: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


52-52: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


112-112: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


112-112: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


139-139: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


263-263: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


265-265: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


265-265: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


266-266: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


266-266: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


267-267: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


267-267: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


268-268: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


269-269: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


269-269: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


270-270: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


270-270: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


271-271: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


271-271: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


272-272: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


272-272: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


273-273: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


273-273: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


274-274: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


274-274: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


275-275: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


275-275: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


276-276: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


276-276: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


423-423: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


477-477: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


477-477: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


478-478: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


478-478: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


479-479: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


479-479: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


480-480: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


480-480: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


481-481: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


481-481: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


482-482: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


482-482: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


483-483: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


483-483: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


484-484: Spaces inside link text
null

(MD039, no-space-in-links)

🪛 LanguageTool
README.md

[duplication] ~139-~139: Possible typo: you repeated a word.
Context: ...rom Scratch in 1000 Lines of Code using Go_](https://betterprogramming.pub/build-a-nosql-database-from-the-scratch-in-1000-lines-of-code-8ed1c15ed924) * [Go: _Build Your Own Database from Scratc...

(ENGLISH_WORD_REPEAT_RULE)


[misspelling] ~274-~274: This word is normally spelled as one.
Context: ...th-keyboard) * [C: Build a minimal multi-tasking kernel for ARM from scratch](https://g...

(EN_COMPOUNDS_MULTI_TASKING)


[duplication] ~467-~467: Possible typo: you repeated a word.
Context: ... first error-correction code in vanilla Python](https://quantum-for-the-confused.medium.com/building-your-first-error-correction-code-in-python-4c1da6d56876) * [Python: Continuous Integration System](htt...

(ENGLISH_WORD_REPEAT_RULE)


[uncategorized] ~478-~478: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...wsbe/) * [Ruby: A Pedometer in the Real World](http://aosabook.org/en/500L/a-pedomet...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[duplication] ~480-~480: Possible typo: you repeated a word.
Context: ... * Rust: Building a DNS server in Rust * [Rust: _Writing Scalable Chat Service from ...

(ENGLISH_WORD_REPEAT_RULE)

@FabriLluvia
Copy link
Author

Solves #1277

@FabriLluvia
Copy link
Author

Closes #1287

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