Update docs: mention Living Documentation Support (#329)

reqnroll · Nov 19, 2024 · 01d9ff7 · 01d9ff7
1 parent 030e854
commit 01d9ff7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,6 +51,8 @@
 
 # -- Options MyST -------------------------------------------------
 
+# See supported Callouts & Admonitions at https://mystmd.org/guide/admonitions
+
 myst_enable_extensions = [
     "attrs_block"
 ]

diff --git a/docs/guides/migrating-from-specflow.md b/docs/guides/migrating-from-specflow.md
@@ -24,6 +24,9 @@ It is also worth mentioning that Reqnroll is based on the SpecFlow v4 codebase,
 It is recommended to upgrade directly to the latest version of Reqnroll (e.g. v2.0), as we keep improving the migration experience and fix issues that might block migration.
 ```
 
+```{attention} Living Documentation Support
+The SpecFlow+ LivingDoc was part of the closed source implementation of SpecFlow and therefore we could not take it over for Reqnroll. We are currently in a process of re-building the tool (or something similar to that), but with a workaround you can also use Reqnroll with the SpecFlow Living Doc Generator CLI tool. See more information about the plans and the workaround at the [Living Documentation discussion topic](https://github.com/orgs/reqnroll/discussions/196).
+```
 
 {#specflow-compatibility-package}
 ## Migrate with the Reqnroll SpecFlow Compatibility Package