summaryrefslogtreecommitdiff
path: root/docs/ZED_EDITOR_SETUP.md
diff options
context:
space:
mode:
authorIndrajith K L2025-11-07 04:44:30 +0530
committerIndrajith K L2025-11-07 04:44:30 +0530
commitf3373d08c74e36b2161e1f4e4eef6aa7197352e0 (patch)
tree37b07d916f921ddb028fbd729fedddb5d310c7d6 /docs/ZED_EDITOR_SETUP.md
parent8c4b587a2347a911d165f0b4afcce116970ad7e5 (diff)
downloadreilua-enhanced-f3373d08c74e36b2161e1f4e4eef6aa7197352e0.tar.gz
reilua-enhanced-f3373d08c74e36b2161e1f4e4eef6aa7197352e0.tar.bz2
reilua-enhanced-f3373d08c74e36b2161e1f4e4eef6aa7197352e0.zip
docs: Add HTML documentation generator and improve documentation structure
- Add html_docs/ directory with Python-based documentation generator - Include custom CSS styling for modern, clean documentation layout - Update README.md with improved formatting and documentation links - Enhance markdown documentation across all docs/ files: - Improve API documentation with better code examples - Refactor DOCUMENTATION_INDEX.md for clearer navigation - Update EMBEDDING.md, CUSTOMIZATION.md, and other guides - Standardize formatting and improve readability throughout - Fix inconsistent line endings and formatting issues The HTML documentation generator creates a styled, browsable version of the project documentation for easier reading and navigation.
Diffstat (limited to 'docs/ZED_EDITOR_SETUP.md')
-rw-r--r--docs/ZED_EDITOR_SETUP.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/ZED_EDITOR_SETUP.md b/docs/ZED_EDITOR_SETUP.md
index 626f06b..c1ba754 100644
--- a/docs/ZED_EDITOR_SETUP.md
+++ b/docs/ZED_EDITOR_SETUP.md
@@ -178,10 +178,10 @@ end
```
If autocomplete works, you should see:
-- ✅ Function suggestions when typing `RL.`
-- ✅ Parameter hints when calling functions
-- ✅ Documentation on hover
-- ✅ Constant values (RL.RED, RL.KEY_SPACE, etc.)
+- Function suggestions when typing `RL.`
+- Parameter hints when calling functions
+- Documentation on hover
+- Constant values (RL.RED, RL.KEY_SPACE, etc.)
---
@@ -237,7 +237,7 @@ Add these to suppress common false positives:
}
```
-**Common warnings and what they mean:**
+Common warnings and what they mean:
- `lowercase-global` - Using global variables with lowercase names (RL is intentional)
- `unused-local` - Local variables that aren't used
- `duplicate-set-field` - Redefining functions (callback functions are expected to be redefined)
@@ -267,7 +267,7 @@ function RL.init() end
RL.init = nil
```
-**Fix Steps:**
+Fix Steps:
1. **Update `tools/ReiLua_API.lua`** - Copy the latest version from the repository
2. **Or add to diagnostics.disable** in your configuration:
```json
@@ -277,11 +277,11 @@ RL.init = nil
```
3. **Restart Zed** to reload the configuration
-**Benefits of the new approach:**
-- ✅ No duplicate warnings
-- ✅ Still get autocomplete
-- ✅ Still get documentation on hover
-- ✅ Still get type checking
+Benefits of the new approach:
+- No duplicate warnings
+- Still get autocomplete
+- Still get documentation on hover
+- Still get type checking
---
@@ -431,4 +431,4 @@ Then copy `tools/ReiLua_API.lua` to your project root, and you're ready to go!
---
-**Happy Coding! 🚀**
+Happy Coding!