Skip to content

docs: update documentation for 2.0 release - #951

Merged
MateuszKubuszok merged 1 commit into
masterfrom
docs/2.0-doc-audit
Sep 5, 2026
Merged

MateuszKubuszok merged 1 commit into
masterfrom
docs/2.0-doc-audit

Conversation

@MateuszKubuszok

Copy link
Copy Markdown
Member

Summary

  • Update user-facing documentation and Scaladoc for the upcoming Chimney 2.0.0 release.
  • Replace obsolete 1.x syntax and references, and correct Cats, Kindlings, Hearth, derivation, and partial-result guidance.
  • Repair broken Scaladoc links and replace obsolete chimney-macro-commons guidance with Hearth guidance.
  • Refresh llm.txt/llms.txt with version-relative links and an llms.txt-compatible structure.

The historical “newest stable versions” matrix is intentionally unchanged. The quickstart remains a minimal user example and is not added to snippet compilation.

Verification

  • sbt --client 'scalafmtCheckAll; chimney/doc; chimney2_13/doc'
  • git diff --check

The documentation was checked against the local 2.0.0-RC1 code baseline; the changes target the forthcoming 2.0.0 release.

@codecov

codecov Bot commented Sep 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.74%. Comparing base (36b7d54) to head (e572355).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #951   +/-   ##
=======================================
  Coverage   82.74%   82.74%           
=======================================
  Files         183      183           
  Lines        7331     7331           
  Branches      529      529           
=======================================
  Hits         6066     6066           
  Misses       1265     1265           

☔ 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.

// Extension methods in dsl.* summon TypeClass.AutoDerived while extension methods in syntax.* summon TypeClass.
// This help us preserve legacy behavior in dsl code while keeping stricter separation in auto/syntax imports.
// Keep the legacy dsl.* signatures using the AutoDerived compatibility aliases; syntax.* uses the type classes
// directly.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

AutoDerived is not used anywhere

@MateuszKubuszok

Copy link
Copy Markdown
Member Author

Addressed the AutoDerived review comment across all four Scala 2/3 DSL and syntax sources. The inaccurate implementation comment was removed; remaining AutoDerived references are the actual compatibility aliases or explicitly historical migration examples.

@MateuszKubuszok
MateuszKubuszok merged commit 48e96c9 into master Sep 5, 2026
17 checks passed
@MateuszKubuszok
MateuszKubuszok deleted the docs/2.0-doc-audit branch September 5, 2026 11:53
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.

1 participant