Skip to content

docs(docs):preencher páginas de introdução com dados da comunidade#368

Open
ewbenigno wants to merge 1 commit into
he4rt:4.xfrom
ewbenigno:docs/preenche-introducao
Open

docs(docs):preencher páginas de introdução com dados da comunidade#368
ewbenigno wants to merge 1 commit into
he4rt:4.xfrom
ewbenigno:docs/preenche-introducao

Conversation

@ewbenigno

Copy link
Copy Markdown

Preenche as 5 páginas de introdução da documentação (issue #336).
Dados levantados via documentação legada, Discord e GitHub da organização.
Pendente: query SQL para número de reuniões realizadas (a confirmar com a equipe).
Estimativas: número de projetos open source e contribuidores ativos baseados nos repositórios públicos de github.com/he4rt.

@ewbenigno ewbenigno marked this pull request as ready for review June 30, 2026 17:50
@ewbenigno ewbenigno requested a review from a team June 30, 2026 17:50
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Four Portuguese introduction pages (como-participar.md, marcos-e-conquistas.md, nossos-valores.md, reunioes-semanais.md) are updated to remove draft/placeholder warnings and substitute concrete values: a Discord invite URL, a GitHub org repositories URL, a "fórum-de-ajuda" channel name, a Code of Conduct link, a weekly meeting schedule (Monday 22h Brasília time, Discord "apresentações" voice channel), and structured community milestone/metric lists.

Possibly related issues

Suggested reviewers

  • Clintonrocha98
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change: populating introduction docs with community data.
Description check ✅ Passed The description directly describes filling the intro pages with community data and notes the pending SQL confirmation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Warning

Tools execution failed with the following error:

Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error)


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (1)
docs/introduction/reunioes-semanais.md (1)

24-24: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Trailing whitespace before line break.

Remove the trailing space after "servidor" to avoid rendering inconsistency.

- no canal de voz **apresentações** do servidor 
+ no canal de voz **apresentações** do servidor
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/reunioes-semanais.md` at line 24, The sentence in the
weekly meetings introduction has trailing whitespace after “servidor”, which
should be removed to avoid rendering inconsistency. Update the markdown text in
the affected line so the phrasing around “Os encontros são realizados no canal
de voz apresentações do servidor” has no extra space before the line break.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/introduction/como-participar.md`:
- Around line 18-19: The Discord reference is currently written as plain
parenthesized text instead of a clickable Markdown link. Update the link in the
participation section of como-participar.md to use proper Markdown link syntax
or angle-bracket URL syntax, and make sure the Discord invite text renders as an
actual clickable link.
- Line 37: The GitHub URL in the participation doc is plain text instead of a
clickable Markdown link; update the reference in the introduction content so it
uses proper Markdown link syntax, and verify the surrounding text in the same
section renders as an actual clickable link rather than a literal parenthesized
URL.

In `@docs/introduction/marcos-e-conquistas.md`:
- Around line 19-21: The introductory sentence is missing a preposition before
the year, so update the text in the markdown content to read naturally by
inserting “em” before 2018 or rephrasing it to “no início de 2018”; locate the
affected sentence in the introductory paragraph and adjust the wording
accordingly.

In `@docs/introduction/nossos-valores.md`:
- Line 33: The Code of Conduct reference is currently written as a bare
parenthesized URL, which breaks the paragraph flow and won’t render as a proper
clickable link. Update the sentence in the markdown so the existing reference is
integrated inline as a Markdown link, keeping the surrounding text in the same
paragraph and preserving the intended wording.

---

Nitpick comments:
In `@docs/introduction/reunioes-semanais.md`:
- Line 24: The sentence in the weekly meetings introduction has trailing
whitespace after “servidor”, which should be removed to avoid rendering
inconsistency. Update the markdown text in the affected line so the phrasing
around “Os encontros são realizados no canal de voz apresentações do servidor”
has no extra space before the line break.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 59d4fcd8-e62f-4a0e-96cc-5afc964a1f38

📥 Commits

Reviewing files that changed from the base of the PR and between ade5d6c and 1497c84.

📒 Files selected for processing (4)
  • docs/introduction/como-participar.md
  • docs/introduction/marcos-e-conquistas.md
  • docs/introduction/nossos-valores.md
  • docs/introduction/reunioes-semanais.md

Comment on lines +18 to 19
(https://discord.gg/he4rt)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Discord URL is not a clickable Markdown link.

The URL (https://discord.gg/he4rt) renders as literal text. Use [text](url) or bare <url> syntax.

- (https://discord.gg/he4rt)
+ <https://discord.gg/he4rt>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(https://discord.gg/he4rt)
<https://discord.gg/he4rt>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/como-participar.md` around lines 18 - 19, The Discord
reference is currently written as plain parenthesized text instead of a
clickable Markdown link. Update the link in the participation section of
como-participar.md to use proper Markdown link syntax or angle-bracket URL
syntax, and make sure the Discord invite text renders as an actual clickable
link.

A He4rt mantém projetos open source feitos pela comunidade. Você pode contribuir
com código, documentação, ideias ou ajudando outras pessoas.
[a confirmar: link para os repositórios / organização no GitHub.]
(https://github.com/orgs/he4rt/repositories)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

GitHub URL is not a clickable Markdown link.

Same issue: (https://github.com/orgs/he4rt/repositories) renders as literal text.

- (https://github.com/orgs/he4rt/repositories)
+ <https://github.com/orgs/he4rt/repositories>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(https://github.com/orgs/he4rt/repositories)
<https://github.com/orgs/he4rt/repositories>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/como-participar.md` at line 37, The GitHub URL in the
participation doc is plain text instead of a clickable Markdown link; update the
reference in the introduction content so it uses proper Markdown link syntax,
and verify the surrounding text in the same section renders as an actual
clickable link rather than a literal parenthesized URL.

Comment on lines +19 to 21
começou como um grupo pequeno 2018 foi ganhando vida a
cada conversa, live e projeto compartilhado.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Missing preposition before year.

"começou como um grupo pequeno 2018" → add "em" or rephrase to "no início de 2018".

- começou como um grupo pequeno 2018 foi ganhando vida a
+ começou como um grupo pequeno em 2018 e foi ganhando vida à
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/marcos-e-conquistas.md` around lines 19 - 21, The
introductory sentence is missing a preposition before the year, so update the
text in the markdown content to read naturally by inserting “em” before 2018 or
rephrasing it to “no início de 2018”; locate the affected sentence in the
introductory paragraph and adjust the wording accordingly.

A He4rt é um espaço para todas as pessoas. Não há lugar para preconceito,
assédio ou qualquer forma de discriminação.
[a confirmar: link para o Código de Conduta oficial da comunidade.]
(https://github.com/he4rt/docs/blob/main/subpage/code-of-conduct.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Code of Conduct URL is not a clickable Markdown link and breaks paragraph flow.

The parenthesized URL renders as literal text and sits on its own line. Integrate it into the preceding sentence as a proper link.

  A He4rt é um espaço para todas as pessoas. Não há lugar para preconceito,
- assédio ou qualquer forma de discriminação.
- (https://github.com/he4rt/docs/blob/main/subpage/code-of-conduct.md)
+ assédio ou qualquer forma de discriminação. Leia nosso [Código de Conduta](https://github.com/he4rt/docs/blob/main/subpage/code-of-conduct.md).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/nossos-valores.md` at line 33, The Code of Conduct
reference is currently written as a bare parenthesized URL, which breaks the
paragraph flow and won’t render as a proper clickable link. Update the sentence
in the markdown so the existing reference is integrated inline as a Markdown
link, keeping the surrounding text in the same paragraph and preserving the
intended wording.

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