openresty / openresty/lua-nginx-module

the docs site doesn't reflect the updated features in the module

Open
#2,304 0 comments 0 reactions 0 assignees View on GitHub

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:

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.