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.
This commit is contained in:
2025-11-07 04:44:30 +05:30
parent 8c4b587a23
commit f3373d08c7
16 changed files with 8831 additions and 279 deletions

View File

@@ -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!