docs(readme): rewrite for clarity, SEO and AI answer engines (EN + ES) by KrilinZ · Pull Request #32 · 4GeeksAcademy/python-http-requests-api-tutorial-exercises · GitHub
Rewrite of the root README in both languages, for clarity, search engines and AI answer engines. No content removed: everything that was there is either still visible or moved inside <!-- hide -->.
Why some sections moved inside <!-- hide -->
Everything between those markers is stripped before the README is published on 4geeks.com, but still shows here on GitHub. The platform already renders its own h1 and its own stats (skill level, duration) from the database, so repeating them in the body shows up twice and can drift out of sync. Title, badges, the metadata block, install steps, repo layout and contributors now live there.
What was added to the published part
An opening summary, what you will learn, what you will build (the real exercises, counted), prerequisites, common mistakes taken from the exercise content itself, and an FAQ with one ### heading per question.
Two constraints worth knowing
No markdown tables in the published part. The 4geeks.com renderer has no table extension, so a table shows up there as raw pipes and dashes. Lists are used instead.
Code fences inside a numbered list must be indented. At column 0 they close the list, which splits it into several <ol> blocks and restarts the numbering. This was happening and is fixed.
Every link in both files was verified — and on 4geeks.com specifically by reading the rendered body, because that domain returns HTTP 200 for URLs that do not exist.
Happy to adjust tone, wording or structure. If the direction looks right, the same treatment can be applied to the rest of the exercise repos.
This file contains hidden or 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
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.
Rewrite of the root README in both languages, for clarity, search engines and AI answer engines. No content removed: everything that was there is either still visible or moved inside <!-- hide -->.
Why some sections moved inside <!-- hide -->
Everything between those markers is stripped before the README is published on 4geeks.com, but still shows here on GitHub. The platform already renders its own h1 and its own stats (skill level, duration) from the database, so repeating them in the body shows up twice and can drift out of sync. Title, badges, the metadata block, install steps, repo layout and contributors now live there.
What was added to the published part
An opening summary, what you will learn, what you will build (the real exercises, counted), prerequisites, common mistakes taken from the exercise content itself, and an FAQ with one ### heading per question.
Two constraints worth knowing
Every link in both files was verified — and on 4geeks.com specifically by reading the rendered body, because that domain returns HTTP 200 for URLs that do not exist.
Happy to adjust tone, wording or structure. If the direction looks right, the same treatment can be applied to the rest of the exercise repos.