Skip to content

docs(readme): rewrite for clarity, SEO and AI answer engines (EN + ES) - #77

Open
KrilinZ wants to merge 2 commits into
4GeeksAcademy:masterfrom
KrilinZ:docs/readme-seo-aio
Open

docs(readme): rewrite for clarity, SEO and AI answer engines (EN + ES)#77
KrilinZ wants to merge 2 commits into
4GeeksAcademy:masterfrom
KrilinZ:docs/readme-seo-aio

Conversation

@KrilinZ

@KrilinZ KrilinZ commented Aug 3, 2026

Copy link
Copy Markdown

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.

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.

1 participant