From 985ad0a077914880083db07f555416273c836d79 Mon Sep 17 00:00:00 2001
From: Marcin Slezak <marcin.slezak@voucherify.io>
Date: Thu, 28 Sep 2023 15:13:37 +0200
Subject: [PATCH] update docs

---
 CONTRIBUTING.md | 10 +++++++---
 Changelog.md    | 14 ++++++++++++++
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b542d9c16..f8bce17f3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -119,7 +119,8 @@ Good practices:
 	- Update tables in markdown tables:
 		- `npm run build-md-tables-from-openapi`
 		- `npm run update-md-tables-in-doc`
-	- Deploy OpenAPI file by command `rdme openapi ./reference/OpenAPI.json --id=<<VERSION_ID>>`, where `<<VERSION_ID>>` should be replaced by the OpenAPI ID that can be found on the `API Reference` page (looks screenshot)
+	- If before created, remove from API Reference the existing OpenAPI file and all specification files.	
+	- Deploy OpenAPI file by command `rdme openapi ./reference/OpenAPI.json --version=2018-08-01-{your name}-{pull request number}`, choose `Create a new spec` option. Command most likely will fail with the message: `We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks`, but so far, we see that this operation still works correctly. 
 	- Deploy guides pages: `rdme docs ./docs/guides --version=2018-08-01-{your name}-{pull request number}`
 	- Deploy api reference pages: `rdme docs ./docs/reference-docs --version=2018-08-01-{your name}-{pull request number}`
 	- Fix docs order: `npm run readme-fix-docs-order -- --version=v2018-08-01-{your name}-{pull request number}`
@@ -131,7 +132,10 @@ Good practices:
 	- publish PR
 
 
-
 ## How to merge PR and update public documentation
 
-> [!TODO] 
\ No newline at end of file
+- Test changes on readme (you can use the version prepared by the contributor).
+- Ensure the changelog was updated.
+- Merge PR to `master` branch
+- In reamde.io, change the current documentation version from `v2018-08-01` to `v2018-08-01-deprecated-mm-dd-yyyy`
+- Change the name of your new release version from `2018-08-01-{your name}-{pull request number}` to `v2018-08-01`
diff --git a/Changelog.md b/Changelog.md
index 5aa488163..4daf624ac 100644
--- a/Changelog.md
+++ b/Changelog.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## 20230928 - Order references/guides script
+
+- Removed `beta` label from qualification API endpoints.
+- Described contribution process.
+- Added the script to clean up OpenAPI from Stoplight tags.
+- Reorganised maintenance scripts.
+- Automated the process of updating the data model documents based on the OpenAPI file.
+- Improve script which generates markdown tables based on the OpenAPI file.
+	- Render objects referred directly by $ref.
+	- fix rendering oneOf + ref.
+	- Render ref to simple types (e.g. enum)
+	- Do not duplicate rendering tables when there is more than one reference.
+	- add the missing title to `23_obj_qualification_object_stacking_rules object.
+
 ## 20230925 - Order references/guides script
 
 Added script, located in `docs/script/` directory to quickly update order of references and guides based on `.md` files. For more information please check [Update-Order-Standard-Work.md](automation%2FUpdate-Order-Standard-Work.md) under `Update Order of Docs - AUTOMATIC` section.