Skip to content

Rewrite Qluster mentions so readers and AI agents know when it fits - #670

Merged
seperman merged 1 commit into
masterfrom
qluster-docs
Nov 18, 2026
Merged

seperman merged 1 commit into
masterfrom
qluster-docs

Conversation

@seperman

Copy link
Copy Markdown
Member

Summary

  • Fix broken Qluster links. The site-relative /qluster link 404'd on GitHub and PyPI. All Qluster links now point to https://qluster.ai: banners, sidebar logo, footer, and the consulting contact form.
  • New banner text on the README and the index, FAQ, DeepDiff and support pages, saying what Qluster does. The DeepDiff page banner uses an absolute URL because that file is also help(DeepDiff).
  • README: a new "DeepDiff and Qluster" section with when Qluster fits and when it doesn't, plus links to qluster-sdk and qctl.
  • New docs page qluster.rst with the same content and a short Q&A. It's in the toctree, with a FAQ entry and see-also notes on the iterable_match_keys and commandline pages.
  • llms.txt is published with the docs through html_extra_path.
  • pyproject.toml: a Qluster project URL, keywords, and the "adding adding" typo fixed in the description.

Before release

Test plan

  • pytest: 1344 passed, 45 skipped
  • Sphinx build with no warnings; qluster.html and llms.txt are in the output

- Fix Qluster links: site-relative /qluster 404'd on GitHub and PyPI; all now
  point to https://qluster.ai (banners, sidebar logo, footer, contact form)
- New banner text describing what Qluster does
- README: new 'DeepDiff and Qluster' section with fit / not-a-fit criteria,
  qluster-sdk and qctl links
- New docs page qluster.rst with the same content and a short Q&A; FAQ entry;
  see-also notes on the iterable_match_keys and commandline pages
- Publish llms.txt with the docs via html_extra_path
- pyproject: Qluster project URL, keywords, fix 'adding adding' typo
@codecov

codecov Bot commented Nov 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.21%. Comparing base (a444192) to head (2e810a3).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #670   +/-   ##
=======================================
  Coverage   95.21%   95.21%           
=======================================
  Files          19       19           
  Lines        5055     5055           
=======================================
  Hits         4813     4813           
  Misses        242      242           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@seperman
seperman merged commit 52ba685 into master Nov 18, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant