Add Hub Audit Logs Documentation

[mindmonk]

Added a new Hub Audit Logs page to the documentation.

[coderabbitai]

Walkthrough

The pull request introduces a new documentation section for Audit Logs in the Cryptomator Hub. The revision adds the file source/hub/audit-logs.rst, which details security-related events such as device registration, vault access grants, and user account resets. The documentation specifies that Audit Logs are not available with a Community License. It further outlines the structure of the Audit Log Table View, including columns for Timestamp, Event, and Details, and explains pagination and filtering options with subsections for filtering by date range and event type. Additionally, the table of contents in the "Hub" section of source/index.rst has been updated to include the new Audit Logs document.

Possibly related PRs

• Add Hub Audit Logs Documentation #73: Introduced similar documentation changes by adding the Audit Logs section in source/hub/audit-logs.rst with the same content and structure.

Suggested reviewers

• SailReal

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f8302c and cf6fbad.

⛔ Files ignored due to path filters (3)

• source/img/hub/auditlogs-filter-events.png is excluded by !**/*.png
• source/img/hub/auditlogs-filter.png is excluded by !**/*.png
• source/img/hub/auditlogs-overview.png is excluded by !**/*.png

📒 Files selected for processing (2)

• source/hub/audit-logs.rst (1 hunks)
• source/index.rst (1 hunks)

🔇 Additional comments (5)

source/index.rst (1)

70-70: Audit Logs Navigation Integration Approved.
The addition of hub/audit-logs.rst under the "Hub" toctree is correctly integrated. The placement and indentation are consistent with other entries.

source/hub/audit-logs.rst (4)

1-10: Documentation Header and Note Section Look Good.
The file begins with a proper anchor declaration and title ("Audit Logs") with appropriate section underlining. The introductory text clearly explains the purpose, and the ".. note::" directive effectively communicates that Audit Logs are unavailable with a Community License.

---

12-34: Event Types Section is Comprehensive.
The "Event Types" subsection is well-structured. The list of logged events is clear and covers a wide range of actions. Ensure that the event names (e.g., SettingWotUpdate, SignedWotId) match the nomenclature used elsewhere in the system for consistency.

---

35-45: Audit Log Table View Section is Clear.
The "Audit Log Table View" section describes the table columns and layout concisely. The inclusion of an image directive with alt text enhances clarity. Just confirm that the referenced image (../img/hub/auditlogs-overview.png) exists and is correctly located relative to this file.

---

51-66: Filtering Audit Logs Section is Well-Documented.
The filtering functionality is described clearly, and the use of images to illustrate the filtering options is a good touch. As a best practice, consider ensuring a trailing newline at the end of the file if it’s not already present.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[SailReal]

Please also change the keys of the list items to what the user actual sees in the audit log e.g. change DeviceRegister to Register Device

[SailReal]

Please explain what this means

[SailReal]

Suggested change

	- **VaultMemberUpdate** – A vault member’s permissions have been updated.
	- **VaultMemberUpdate** – A vault member’s role (owner VS user) have been updated.

Add also a link to https://docs.cryptomator.org/hub/vault-management/#change-ownership

[SailReal]

Please add a link to https://docs.cryptomator.org/hub/vault-management/#edit-vault-metadata

[SailReal]

Please add a link to https://docs.cryptomator.org/hub/your-account/#account-key and also explain when this happens.

[SailReal]

Suggested change

	- **UserSetupCodeChanged** – A user’s setup code has been changed.
	- **UserSetupCodeChanged** – A user’s Account Key has been changed.

Please also add a link to https://docs.cryptomator.org/hub/your-account/#regenerate-account-key

[SailReal]

Add a link to https://docs.cryptomator.org/hub/vault-management.html#web-of-trust

[SailReal]

Add a link to https://docs.cryptomator.org/hub/vault-management/#create-a-vault

[SailReal]

Add a link to https://docs.cryptomator.org/hub/vault-management/#update-permissions

[SailReal]

Add a link to https://docs.cryptomator.org/hub/vault-management/#share-a-vault

[SailReal]

Describe when this is logged