Skip to content

chore(docs): fix tables formatting #10010

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Nov 5, 2025
Merged

chore(docs): fix tables formatting #10010

merged 6 commits into from
Nov 5, 2025

Conversation

@dfokina
Copy link
Contributor

@dfokina dfokina commented Nov 4, 2025 •
edited
Loading

The Problem

  • Many of tables in docs pages either had missing header rows, or the header row was preceeded by an empty row
  • The "headerless" tables (in component docs) always had a first empty row due to markdown table limitation

Proposed Changes:

  • Add missing headers to tables
  • Implement a CSS solution for headerless tables in custom.css
  • Update the headerless tables to use className="key-value-table" for headerless rendering, only for 2.19 and 2.20-unstable. V2.18 was left unchanged to limit the review scope.

What is the difference:
OLD with empty header
Screenshot 2025-11-04 at 21 39 50
NEW
Screenshot 2025-11-04 at 21 39 57

How did you test it?

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added unit tests and updated the docstrings
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@vercel
Copy link

vercel bot commented Nov 4, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
haystack-docs Ready Ready Preview Comment Nov 4, 2025 8:40pm

@dfokina dfokina changed the title docs: fix tables formatting chore(docs): fix tables formatting Nov 4, 2025
@dfokina dfokina added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Nov 4, 2025
@dfokina dfokina marked this pull request as ready for review November 4, 2025 20:51
@dfokina dfokina requested a review from a team as a code owner November 4, 2025 20:51
@dfokina dfokina requested review from davidsbatista and removed request for a team November 4, 2025 20:51
davidsbatista
davidsbatista approved these changes Nov 5, 2025
View reviewed changes
Copy link
Contributor

@davidsbatista davidsbatista left a comment

Choose a reason for hiding this comment

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

LGTM

@davidsbatista davidsbatista merged commit 9371283 into main Nov 5, 2025
14 checks passed
@davidsbatista davidsbatista deleted the headless-tables branch November 5, 2025 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidsbatista davidsbatista davidsbatista approved these changes

Assignees

No one assigned

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dfokina @davidsbatista