Skip to content

docs: audit MongoDB and Redis module pages#22

Merged
demengc merged 1 commit intomainfrom
docs/audit-mongo-redis-modules
Mar 24, 2026
Merged

docs: audit MongoDB and Redis module pages#22
demengc merged 1 commit intomainfrom
docs/audit-mongo-redis-modules

Conversation

@demengc
Copy link
Copy Markdown
Owner

@demengc demengc commented Mar 24, 2026

Summary

  • MongoDB: Added dependency snippet, credentials field table, ConfigurationSection factory method docs, API reference table (getClient(), getDatabase(), getDatabase(String), close()), corrected Terminable (was AutoCloseable), reordered sections (Queries/Indexes before Complete Example).
  • Redis: Documented both AsyncRedisMessageReceiveEvent and RedisMessageReceiveEvent (previously only async was shown), documented constructor varargs channels parameter, added credentials field table with nullable column, added ConfigurationSection factory method docs, added full API reference table (including subscribe, unsubscribe, isSubscribed, return types), added event properties table (getSenderId, getMessage, getMessageObject, getTimestamp), corrected Terminable (was AutoCloseable), fixed thread-safety issue in examples (Bukkit API calls now use sync event).
  • Both pages now include Maven dependency snippets with current version (1.36.1-SNAPSHOT) and mention the shaded library versions (MongoDB driver 5.6.1, Jedis 7.0.0).

Test plan

  • Verify all method names, parameter types, and return types match the source code
  • Verify code examples compile against the current API
  • Confirm GitBook renders markdown tables correctly

@demengc demengc merged commit bfa9034 into main Mar 24, 2026
2 of 3 checks passed
@demengc demengc deleted the docs/audit-mongo-redis-modules branch March 24, 2026 02:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant