GRAPH.ACL command documentation

[danshalev7]

Updated formatting and corrected syntax in the GRAPH.ACL documentation.

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for GRAPH.ACL command with detailed syntax, subcommands (SETUSER, GETUSER, DELUSER, LIST), usage patterns, supported rules, examples, and expected responses.

[coderabbitai]

Walkthrough

A new Markdown documentation file for the GRAPH.ACL command has been added, providing detailed information about the command's purpose, syntax, subcommands (SETUSER, GETUSER, DELUSER, LIST), usage patterns, supported rules, examples, and expected responses.

Changes

Cohort / File(s)	Summary
Documentation commands/graph.acl.md	New documentation file detailing GRAPH.ACL command with syntax, subcommands, usage patterns, rules, examples, and responses

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify technical accuracy of command documentation and syntax examples
• Confirm consistency with existing command documentation style and format
• Check completeness of subcommand descriptions and usage patterns

Poem

🐰 Hop, hop, hooray! The docs now bloom,
ACL commands chase away the gloom,
With SETUSER, GET, and LIST so fine,
A rabbit's guide makes all align! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'GRAPH.ACL command documentation' directly and clearly summarizes the main change: adding documentation for the GRAPH.ACL command.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch danshalev7-patch-6

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

commands/graph.acl.md (3)

19-25: Reconcile the subcommand ordering.

The subcommands list (lines 19-25) shows the order as GETUSER, SETUSER, DELUSER, LIST, but the detailed sections follow the order SETUSER, GETUSER, DELUSER, LIST. Either reorder the list to match the sections or reorganize the sections to match the list for consistency.

  ### Subcommands
  
- 1. `GETUSER`
- 2. `SETUSER`
- 3. `DELUSER`
- 4. `LIST`
+ 1. `SETUSER`
+ 2. `GETUSER`
+ 3. `DELUSER`
+ 4. `LIST`

---

93-98: Add an example and expected output to the LIST section for consistency.

The SETUSER and GETUSER sections include examples and expected responses, but the LIST section only shows the command syntax without an example or sample output. Adding these would enhance clarity and consistency with the other sections.

  #### GRAPH.ACL LIST
  
  Lists all existing users.
  ```text
  GRAPH.ACL LIST

• Example:
• GRAPH.ACL LIST
• Response:
• 1. "john"
• 2. "jane"

---

`35-41`: **Consider clarifying the distinction between +GRAPH.QUERY and +GRAPH.RO_QUERY.**

The SETUSER section lists both `+GRAPH.QUERY` and `+GRAPH.RO_QUERY` in the supported rules, and the example grants both permissions. A brief note clarifying whether these are mutually exclusive, complementary, or if one is a subset of the other would help users understand the permission model better.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: CodeRabbit UI

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 6f2c2bba102e8d976aa54ba6dc9af68ed33ff350 and f281964c1ed08b81c6c6cc51b79d326bee541f1c.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `commands/graph.acl.md` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🧠 Learnings (1)</summary>

<details>
<summary>📓 Common learnings</summary>

Learnt from: gkorland
Repo: FalkorDB/docs PR: 89
File: commands/acl.md:0-0
Timestamp: 2024-12-04T13:48:42.158Z
Learning: In commands/acl.md, it's acceptable to include actual password values like >password123 in example outputs for documentation purposes.

</details>

</details>

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->