chore: update docs (#44)

openfga · Aug 27, 2024 · 7529107 · 7529107
1 parent c0e2463
commit 7529107
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
@@ -6,12 +6,16 @@ Read the [OpenFGA Contribution Process](https://github.com/openfga/.github/blob/
 
 ### Run Build & tests
 
-```./gradlew build```
+`./gradlew build`
+
+### Run IDE extension in sandbox
+
+`./gradlew runIde`
 
 ## Distribution (Optional)
 
 To generate an installable build of this plugin, you can do the following:
 
-```./gradlew buildPlugin```
+`./gradlew buildPlugin`
 
 [Instructions for installation from disk](https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk)
diff --git a/docs/RELEASING.md b/docs/RELEASING.md
@@ -8,8 +8,8 @@
 ## Update the CHANGELOG
 
 You will need to;
-- update the [CHANGELOG.md](../CHANGELOG.md)
-- update the "change-notes" section of the [plugin.xml](../src/main/resources/META-INF/plugin.xml)
+- update the [CHANGELOG.md](/CHANGELOG.md)
+- update the "change-notes" section of the [plugin.xml](/src/main/resources/META-INF/plugin.xml)
     - This will appear in the "What's new?" section of the plugin page
 
 ## When ready, push a new tag