Docs on docusaurus

.gitignore

@@ -24,3 +24,4 @@ ruby_event_store-browser/public/*
 .inch/
 .tmp
 support/bundler/*.lock
+.DS_Store

netlify.toml

@@ -1,12 +1,11 @@
 [build]
-  base = "railseventstore.org/"
+  base = "railseventstore.org"
   command = "make build"
   publish = "build/"
   ignore  = "false"
 
 [build.environment]
   NODE_VERSION = "20.10"
-  RUBY_VERSION = "3.2.2"
 
 [[redirects]]
   from = "http://www.railseventstore.org/*"

railseventstore.org/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

railseventstore.org/Makefile

@@ -1,14 +1,23 @@
 install: ## Install dependencies
-	@bundle install
 	@npm install --no-fund --no-audit
+.PHONY: install
 
 build: ## Output static files (production)
-	@bundle exec middleman build
+	@npm run build
+.PHONY: build
 
+serve:
+	@npm run serve
+.PHONY: serve
+
+watch:
+	@npx chokidar-cli "docs/**/*.md" \
+		-c "make build" \
+		--initial
+.PHONY: watch
 
 dev: ## Run server (development)
-	@bundle exec middleman server
+	@$(MAKE) -j2 watch serve
+.PHONY: dev
 
 include ../support/make/help.mk
-
-.PHONY: install build dev

railseventstore.org/README.md

@@ -4,8 +4,6 @@ Source files for the documentation and website of [Rails Event Store](https://ra
 
 ## Serving the docs locally
 
-Provided you have Ruby installed, you can serve the docs locally at `http://localhost:4567`
-
 ```
 bundle install
 npm install
@@ -16,6 +14,10 @@ bundle exec middleman server
 
 Documentation and website are deployed continuously and automatically from the `master` branch.
 
+## Docs navigation update 
+
+The navigation is now generated from the `sidebars.json` file. You need to restart the development server after updating the file.
+
 ## About
 
 <img src="http://arkency.com/images/arkency.png" alt="Arkency" width="20%" align="left" />

railseventstore.org/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

railseventstore.org/source/docs/v2/bi-temporal.html.md → railseventstore.org/docs/advanced-topics/bi-temporal.md

@@ -11,11 +11,11 @@ Consider you're an HR person responsible for dealing with employee salaries. You
 When you gather the information from managers, you put them into an Excel sheet and mail them to payroll. Payroll is taking care of the money getting into employees' bank accounts. You also import the Excel sheet into your HR system, which happens to be Event Sourced.
 
 Usually, things go great and we build our stream of salary-tracking events like this:
-![BiTemporalEventSourcingWhenThingsGoSmoothly](../../images/bi_temporal_event_sourcing_when_things_go_smoothly.jpg)
+![BiTemporalEventSourcingWhenThingsGoSmoothly](/images/bi_temporal_event_sourcing_when_things_go_smoothly.jpg)
 However an error might happen. The error might happen when gathering the data from manager or putting it into an Excel sheet.
 
 Instead of asking a developer to modify the event data (events should always be immutable!), you could use a bi-temporal event. Consider the example below:
-![BiTemporalEventSourcingValidAt](../../images/bi_temporal_valid_at_event_sourcing.jpg)
+![BiTemporalEventSourcingValidAt](/images/bi_temporal_valid_at_event_sourcing.jpg)
 In this example, the salary was raised on January 1, 2020, and it was also paid out on February 1, 2020. Then the mistake was detected. Instead of modifying the history of events, the new one has been published. The new event describes the proper value of the salary and specifies when the salary is valid.
 
 ## Usage

railseventstore.org/source/docs/v2/repository.html.md → railseventstore.org/docs/advanced-topics/custom-repository.md

@@ -32,7 +32,7 @@ Those repositories were written by community members and are not guaranteed to b
 
 ## Writing your own repository
 
-If you want to write your own repository, we provide [a suite of tests that you can re-use](https://github.com/RailsEventStore/rails_event_store/blob/master/ruby_event_store/lib/ruby_event_store/spec/event_repository_lint.rb). Just [require](https://github.com/RailsEventStore/rails_event_store/blob/a6ffb8a535373023296222bbbb5dd6ee131a6792/rails_event_store_active_record/spec/event_repository_spec.rb#L3) and [include it](https://github.com/RailsEventStore/rails_event_store/blob/a6ffb8a535373023296222bbbb5dd6ee131a6792/rails_event_store_active_record/spec/event_repository_spec.rb#L26) in your repository spec. Make sure to meditate on which [expected_version option](/docs/v2/expected_version//) you are going to support and how.
+If you want to write your own repository, we provide [a suite of tests that you can re-use](https://github.com/RailsEventStore/rails_event_store/blob/master/ruby_event_store/lib/ruby_event_store/spec/event_repository_lint.rb). Just [require](https://github.com/RailsEventStore/rails_event_store/blob/a6ffb8a535373023296222bbbb5dd6ee131a6792/rails_event_store_active_record/spec/event_repository_spec.rb#L3) and [include it](https://github.com/RailsEventStore/rails_event_store/blob/a6ffb8a535373023296222bbbb5dd6ee131a6792/rails_event_store_active_record/spec/event_repository_spec.rb#L26) in your repository spec. Make sure to meditate on which [expected_version option](..core-concepts/expected-version/) you are going to support and how.
 
 ## Using RubyEventStore::InMemoryRepository for faster tests
 
@@ -69,7 +69,7 @@ We don't recommend using `InMemoryRepository` in production even if you don't ne
 
 RubyEventStore comes with `RubyEventStore::ROM::EventRepository` that you can use with a SQL database without requiring ActiveRecord or when not using Rails altogether. It is tested with the same test suite as the ActiveRecord implementation and raises identical exceptions.
 
-See [Using Ruby Event Store without Rails](https://railseventstore.org/docs/v2/without_rails//) for information on how to use ROM (and Sequel).
+See [Using Ruby Event Store without Rails](./without-rails) for information on how to use ROM (and Sequel).
 
 ## Using PgLinearizedEventRepository for linearized writes