Skip to content

[docs][P3] README.md: broken markdown bold in Technical overview table (pip row) + missing contact CTA email #487

Description

@FabioLeitao

docs token | thin slice | Composer 2

Gap 1 — Broken markdown in Technical overview table

The last row of the "Technical overview" navigation table has an unclosed bold marker:

| **`pip` from PyPI | **`pip install data-boar`** when published; ...

The opening ** before the backtick in the left cell is never closed, breaking the markdown rendering in that cell. Fix: either remove the bold markers from the left cell or close them properly:

| `pip` from PyPI | **`pip install data-boar`** when published; ...

Gap 2 — "Get in touch" CTA has no contact address

The README says: "We invite you to get in touch to see how Data Boar can support your compliance journey."

There is no email, link, or GitHub Discussions reference. Once contact@databoar.com.br is configured (see #483), add it here:

**We invite you to get in touch**[contact@databoar.com.br](mailto:contact@databoar.com.br) — to see how Data Boar can support your compliance journey.

Fix

  1. Fix the unclosed ** in the Technical overview table pip row
  2. Add contact@databoar.com.br mailto link to the "get in touch" sentence (do this AFTER [decision][P1] Email aliases for databoar.com.br — CODE_OF_CONDUCT, security, DPO, and founder contacts #483 email alias is confirmed active by maintainer)
  3. Also update README.pt_BR.md for both changes
  4. Gate: .\scripts\lint-only.ps1 + uv run pytest tests/test_docs_markdown.py -v -W error
  5. Commit: docs(readme): fix broken bold in table + add contact email to CTA

Out of scope

Do not add badges (tracked in #457). Do not add docker one-liner (tracked in #458).

Metadata

Metadata

Assignees

Labels

P3Low — backlog / nice-to-have

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions