Skip to content

Fixup some things in the documentation that are not true anymore #154

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.

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

Merged
merged 3 commits into from
May 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 6 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,44 +209,18 @@ object ForallExamples extends SimpleIOSuite with Checkers {

Contributions are most welcome !

### Development requirements

:warning: This repository uses [Git LFS](https://git-lfs.github.com/). Having it installed is required for
`git checkout` to work properly.

To install for Mac using `brew`:

```bash
brew install git-lfs
git lfs install
```

If you want to build and run the website then you will need yarn installed:

```bash
brew install yarn
```

### Building the website

If you're changing documentation, here's how you can check your changes locally:

```bash
sbt docs/docusaurusCreateSite
cd website
yarn start
sbt docs/tlSitePreview
```

If you're only changing `.md` files, you can run `sbt '~docs/mdoc'`.

If you want to view images, such as the logo, use `git lfs` to check them out:

```bash
git lfs install --local
git lfs pull
```
Then navigate to `http://localhost:4242` to see the documentation site.

Note that the site will look a tiny bit different because to build a versioned website we have some machinery in the script running on CI - but you don't have to worry about that.
Weaver uses `sbt-typelevel-site`, for more details on writing documentation
[see here](https://typelevel.org/sbt-typelevel/site.html#quick-start).

### PR Guidelines

Expand All @@ -257,6 +231,6 @@ Please:

## Inspiration

A **HUGE** thank you to Alexandru Nedelcu, author of [Monix](https://github.com/monix/monix) and contributor to
cats-effect, as he wrote the [minitest](https://github.com/monix/minitest)
A **HUGE** thank you to Alexandru Nedelcu, author of [Monix](https://github.com/monix/monix)
and contributor to cats-effect, as he wrote the [minitest](https://github.com/monix/minitest)
framework which got this framework started.
30 changes: 15 additions & 15 deletions docs/faqs/other_effects.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
What happened to ZIO / Monix / MonixBIO ?
=============
What happened to other effect types ?
=====================================

Starting with version 0.8.0, Weaver no longer offers out-of-the-box support for other effect types
than cats-effect.
Starting with version 0.8.0, Weaver only supports cats-effect out-of-the-box.

We (maintainers) are happy to keep the core of weaver effect-agnostic, in an effort to allow for third party
to resurrect support for the effect types they use in repository they control.
We (maintainers) are happy to keep the core of weaver effect-agnostic, in an
effort to allow for third party to resurrect support for the effect types they
use in repository they control.

You can read about the rationale for decision [here](https://github.com/disneystreaming/weaver-test/discussions/570). Feel free to ping us via a github discussion, if you seek to resurrect support for a given effect-type.
If you are looking for documentation of the legacy branches of weaver that did
support other effect types, you can find it [in the archived repository](https://github.com/disneystreaming/weaver-test/blob/v0.6.15/docs/installation.md).

If you are looking for documentation of the maintenance branch of weaver that did support other effect types, you can find it [over there](https://github.com/disneystreaming/weaver-test/blob/v0.6.15/docs/installation.md).
To summarize :

We will try to fix critical bugs on the 0.6/0.7 series, as they get found.

To summarise :

* `0.8.x` and further -> CE3 only, active development,
* `0.7.x` -> CE3 + ZIO 1 support (maintenance mode, fixing critical bugs that not have workarounds)
* `0.6.x` -> CE2 + Monix/MonixBIO/ZIO 1 support (maintenance mode, fixing critical bugs that do not have workarounds)
| Version | Cats Effect | ZIO | Monix | maintained? |
| ------- | ----------- | ------ | ------ | ----------- |
| 0.9.x | ✅ 3.x | ❌ | ❌ | ✅ |
| 0.8.x | ✅ 3.x | ❌ | ❌ | ❌ |
| 0.7.x | ✅ 3.x | ✅ 1.x | ❌ | ❌ |
| 0.6.x | ✅ 2.x | ✅ 1.x | ✅ 3.x | ❌ |
169 changes: 0 additions & 169 deletions scripts/releaseSite.sc

This file was deleted.