Skip to content

Add User Groups documentation#15

Open
timroes wants to merge 3 commits intomainfrom
tim/user-groups
Open

Add User Groups documentation#15
timroes wants to merge 3 commits intomainfrom
tim/user-groups

Conversation

@timroes
Copy link
Collaborator

@timroes timroes commented Mar 4, 2026

Add documentation for the upcoming user group feature.

Summary by CodeRabbit

  • Documentation
    • Added a new "User Groups" documentation page covering group-based access management for workspaces and forms, setup steps, permission levels (Use vs Edit), conflict-resolution rules, and related articles.
    • Updated navigation to surface the new "User Groups" doc under Account > Team Collaboration.

@coderabbitai
Copy link

coderabbitai bot commented Mar 4, 2026

📝 Walkthrough

Walkthrough

Added a new "User Groups" documentation page and updated the Fillout docs navigation to include it under Account > Team Collaboration.

Changes

Cohort / File(s) Summary
Documentation & Navigation
docs.json, user-groups.mdx
Added user-groups.mdx describing User Groups: purpose, setup steps, permission levels (Use vs Edit), conflict resolution, warnings, and related articles. Updated docs.json navigation to include the new page under Team Collaboration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through docs to plant a seed,
A page for groups to help teams lead.
Permissions, steps, and links in view,
I stitched the nav so you can too. ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 clearly and accurately summarizes the main change: adding documentation for the User Groups feature.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch tim/user-groups

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@user-groups.mdx`:
- Around line 30-39: The opening sentence currently claims groups can have "Use
or Edit permissions on workspaces or individual forms, apps, or databases" but
the Info block says "Use" isn't implemented for databases; update the lead
sentence to remove ambiguity by stating that Use/Edit apply to workspaces and to
individual forms and apps, and that databases only support Edit (or that Use for
databases is not implemented). Edit the sentence and, if helpful, clarify the
Info block to match this wording so the document consistently indicates
databases do not support Use permissions.
- Around line 23-25: The step titled "Add members & change permissions" uses
mixed references ("each group" / "their" / "this group") which is confusing;
update the copy in that Step so pronouns are consistent (either singular or
plural) — e.g. change to a single, clear sentence such as using "a group" +
"its" or "groups" + "their"; locate the Step element with title "Add members &
change permissions" and replace the existing sentence accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d55f801c-0324-4cf9-8446-0275d3284a71

📥 Commits

Reviewing files that changed from the base of the PR and between 7c48bd7 and 98c1f21.

📒 Files selected for processing (2)
  • docs.json
  • user-groups.mdx

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (2)
user-groups.mdx (2)

23-25: ⚠️ Potential issue | 🟡 Minor

Tighten the Step copy for consistency and readability.

Line [24] is still a bit awkward (“a group” / “this group”) and can be simplified.

✍️ Suggested wording
-    Using the dropdown menu on a group you can manage members or change the permissions of this group.
+    Use a group’s dropdown menu to manage members or update that group’s permissions.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@user-groups.mdx` around lines 23 - 25, The Step titled "Add members & change
permissions" has inconsistent phrasing ("a group" vs "this group"); change the
copy to a single, concise sentence for clarity—locate the Step with title "Add
members & change permissions" in user-groups.mdx and replace the body text with
a tightened, consistent version such as "Use the group's dropdown menu to manage
members and update permissions." Ensure punctuation and capitalization match
surrounding Steps.

30-39: ⚠️ Potential issue | 🟡 Minor

Resolve database permission ambiguity in the lead sentence.

Line [30] implies Use applies to databases, while Line [38] says it is not implemented. Make the scope explicit in the first sentence.

🧩 Suggested wording
-Groups can have **Use** or **Edit** permissions on workspaces or individual forms, apps, or databases within a workspace.
+Groups can have **Use** or **Edit** permissions on workspaces, forms, and apps. For databases, only **Edit** is currently supported.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@user-groups.mdx` around lines 30 - 39, Update the lead sentence that
currently reads "Groups can have **Use** or **Edit** permissions on workspaces
or individual forms, apps, or databases" to explicitly exclude databases for the
**Use** permission (for example: "Groups can have **Use** or **Edit**
permissions on workspaces or individual forms and apps (Use does not apply to
databases)"). Keep the rest of the bullets for **Use** and **Edit** unchanged
and ensure the existing <Info> block that states "Use permissions are currently
not implemented on databases" remains consistent with the revised lead sentence
so there is no ambiguity between the opening sentence and the Info note.
🧹 Nitpick comments (1)
user-groups.mdx (1)

3-8: Align the feature scope between summary and body.

Line [3] and Line [8] frame access as workspace/forms only, but later sections include apps and databases. Consider aligning the opening copy to match the full scope documented below.

✍️ Suggested wording
-description: "Create groups to manage workspace and form access for multiple team members at once."
+description: "Create groups to manage workspace access and permissions for forms, apps, and databases for multiple team members at once."

-User Groups let admins bundle team members together and grant them workspace or form access all at once.
+User Groups let admins bundle team members together and grant workspace, form, app, and database access all at once.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@user-groups.mdx` around lines 3 - 8, Update the top-level description and
opening paragraph for "User Groups" so the feature scope matches later sections:
include apps and databases alongside workspace and form access (e.g., change the
description value and the opening sentence under the "User Groups" heading to
mention workspace, forms, apps, and databases), ensuring the sidebarTitle "User
Groups" and icon remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@user-groups.mdx`:
- Around line 23-25: The Step titled "Add members & change permissions" has
inconsistent phrasing ("a group" vs "this group"); change the copy to a single,
concise sentence for clarity—locate the Step with title "Add members & change
permissions" in user-groups.mdx and replace the body text with a tightened,
consistent version such as "Use the group's dropdown menu to manage members and
update permissions." Ensure punctuation and capitalization match surrounding
Steps.
- Around line 30-39: Update the lead sentence that currently reads "Groups can
have **Use** or **Edit** permissions on workspaces or individual forms, apps, or
databases" to explicitly exclude databases for the **Use** permission (for
example: "Groups can have **Use** or **Edit** permissions on workspaces or
individual forms and apps (Use does not apply to databases)"). Keep the rest of
the bullets for **Use** and **Edit** unchanged and ensure the existing <Info>
block that states "Use permissions are currently not implemented on databases"
remains consistent with the revised lead sentence so there is no ambiguity
between the opening sentence and the Info note.

---

Nitpick comments:
In `@user-groups.mdx`:
- Around line 3-8: Update the top-level description and opening paragraph for
"User Groups" so the feature scope matches later sections: include apps and
databases alongside workspace and form access (e.g., change the description
value and the opening sentence under the "User Groups" heading to mention
workspace, forms, apps, and databases), ensuring the sidebarTitle "User Groups"
and icon remain unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1ad6b16c-8f6b-4709-8927-5877f6ddd350

📥 Commits

Reviewing files that changed from the base of the PR and between 98c1f21 and 0d11840.

📒 Files selected for processing (1)
  • user-groups.mdx

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