Skip to content

docs: reformat all the documentation pages#10554

Merged
kacperlukawski merged 5 commits intodocs-snippets-formattingfrom
docs-snippets-formatting-attempt
Feb 12, 2026
Merged

docs: reformat all the documentation pages#10554
kacperlukawski merged 5 commits intodocs-snippets-formattingfrom
docs-snippets-formatting-attempt

Conversation

@kacperlukawski
Copy link
Member

@kacperlukawski kacperlukawski commented Feb 10, 2026

Related Issues

Notes for the reviewer

See: #10552

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have 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 have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@kacperlukawski kacperlukawski requested review from a team as code owners February 10, 2026 15:26
@kacperlukawski kacperlukawski requested review from sjrl and removed request for a team February 10, 2026 15:26
@vercel
Copy link

vercel bot commented Feb 10, 2026 •
edited
Loading

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Feb 12, 2026 10:32am

Request Review

@kacperlukawski kacperlukawski mentioned this pull request Feb 10, 2026
Merged
anakin87
anakin87 requested changes Feb 10, 2026
View reviewed changes
Copy link
Member

@anakin87 anakin87 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think that only docs-website/**/*.mdx files should be modified (actual documentation, manually added).

docs-website/**/*.md files are API references, automatically generated from docstrings (see here), so pre-commit hooks should not touch them. Or we can instead create a pre-commit hook that makes changes to docstrings.

@kacperlukawski kacperlukawski force-pushed the docs-snippets-formatting-attempt branch from 0e7b8b3 to 67c57c4 Compare February 11, 2026 08:55
anakin87
anakin87 approved these changes Feb 11, 2026
View reviewed changes
Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

I had a look and it seems a good result. Feel free to merge.

@kacperlukawski kacperlukawski force-pushed the docs-snippets-formatting-attempt branch from 67c57c4 to d7b095e Compare February 12, 2026 10:22
@github-actions github-actions bot added the topic:DX Developer Experience label Feb 12, 2026
@kacperlukawski kacperlukawski force-pushed the docs-snippets-formatting-attempt branch from d7b095e to fab46e8 Compare February 12, 2026 10:29
@kacperlukawski
Copy link
Member Author

kacperlukawski commented Feb 12, 2026

@anakin87 Another preview is ready, this time with max 88 characters per line (except for longer document content sometimes). I think it's better. I also found some malformed code snippets (tabs mixed with spaces, or positional arguments after keyword arguments, I'll fix separately).

@anakin87
Copy link
Member

anakin87 commented Feb 12, 2026

@anakin87 Another preview is ready, this time with max 88 characters per line (except for longer document content sometimes). I think it's better. I also found some malformed code snippets (tabs mixed with spaces, or positional arguments after keyword arguments, I'll fix separately).

Looks ok!

@kacperlukawski kacperlukawski merged commit cd3819e into docs-snippets-formatting Feb 12, 2026
11 checks passed
@kacperlukawski kacperlukawski deleted the docs-snippets-formatting-attempt branch February 12, 2026 11:14
kacperlukawski added a commit that referenced this pull request Feb 12, 2026
@kacperlukawski
docs: reformat all the documentation pages (#10554)
c3a9db1 
* feat: allow setting line length

* docs: reformat all the documentation pages

* Revert "docs: reformat all the documentation pages"

This reverts commit 0b36a91.

* docs: reformat only .mdx files

* docs: rerun formatting with 88 characters per line
kacperlukawski added a commit that referenced this pull request Feb 12, 2026
@kacperlukawski
Revert "docs: reformat all the documentation pages (#10554)"
c067c6d 
This reverts commit c3a9db1.
kacperlukawski added a commit that referenced this pull request Feb 12, 2026
@kacperlukawski
style: docs snippets formatting (#10552)
8197a6d 
* style: enable ruff formatting on docs-website

* docs: reformat AmazonBedrockDocumentEmbedder docs

* fix: do not run code snippets formatting on .md files

* feat: allow setting line length

* feat: include logging to detect malformed snippets

* docs: reformat all the documentation pages (#10554)

* feat: allow setting line length

* docs: reformat all the documentation pages

* Revert "docs: reformat all the documentation pages"

This reverts commit 0b36a91.

* docs: reformat only .mdx files

* docs: rerun formatting with 88 characters per line

* Revert "docs: reformat all the documentation pages (#10554)"

This reverts commit c3a9db1.

* feat: add coloring to logs

* docs: reformat the docs with pre-commit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anakin87 anakin87 anakin87 approved these changes

@sjrl sjrl Awaiting requested review from sjrl sjrl was automatically assigned from deepset-ai/open-source-engineering

Assignees

No one assigned

Labels

topic:DX Developer Experience

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kacperlukawski @anakin87