Update README.md

konfig-dev · Oct 10, 2023 · 88e8280 · 88e8280
1 parent 387be7b
commit 88e8280
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/generator/konfig-docs/README.md b/generator/konfig-docs/README.md
@@ -24,6 +24,18 @@ $ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
+
+### How to make a new page
+
+1. Create an `.mdx` file inside [`docs/`](./docs) *(`.mdx` is just markdown with some extra support for interactivity)*
+1. Modify [`sidebars.js`](./sidebars.js) to include your new documentation
+1. Push changes
+
+### How to modify a page
+
+1. Modify the target `.mdx` file inside [`docs/`](./docs) *(`.mdx` is just markdown with some extra support for interactivity)*
+1. Push changes
+
 ### Deployment
 
 Using SSH: