openresty / openresty/lua-nginx-module
the docs site doesn't reflect the updated features in the module
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 11.8k
- Forks
- 2.1k
- Avg merge
- 6h 1m
- Merged PRs (30d)
- 6
Description
I am not sure who maintains or how is the documentation site https://openresty-reference.readthedocs.io/en/latest/Lua_Nginx_API/ is maintained or kept in sync with the README of this repository, thus sharing my concerns here.
Issue:
- It seems like the documentation site is not currently reflecting the newly added features in the module. e.g. https://github.com/openresty/lua-nginx-module#ngxshareddictttl and https://github.com/openresty/lua-nginx-module?tab=readme-ov-file#ngxshareddictexpire is not there....
- Also the API doc for https://github.com/openresty/lua-nginx-module?tab=readme-ov-file#ngxshareddictincr doesn't match. The newest version has 4 parameters whereas the DOC says there's 3 (https://openresty-reference.readthedocs.io/en/latest/Lua_Nginx_API/#ngxshareddictincr)...
- Probably there are more issues in the DOC site which I haven't looked into...
Feel free to close this issue, if the DOC related issues are not maintained from this repository...
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Lua_Nginx_API documentation site with the repository README sections for ngx.shared.DICT:ttl, ngx.shared.DICT:expire, and ngx.shared.DICT:incr. Confirm the missing entries and parameter mismatch, then determine whether the repository or an external documentation project is the maintained source; done means the documented API matches the current README or the issue is redirected to its maintainer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, nginx
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100