Skip to content

docs(user-guide): document default project per user (epmcdme-15109) - #490

Merged
alezander86 merged 4 commits into
codemie-ai:mainfrom
Bondimm:docs/EPMCDME-15109-default-project
Oct 19, 2026
Merged

alezander86 merged 4 commits into
codemie-ai:mainfrom
Bondimm:docs/EPMCDME-15109-default-project

Conversation

@Bondimm

@Bondimm Bondimm commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents the default project per user feature (EPMCDME-15109; delivered in EPMCDME-15110, EPMCDME-15111, EPMCDME-15112, with follow-up fixes EPMCDME-15738, EPMCDME-15739, EPMCDME-15747). Platform Admins and Maintainers can now assign each user a default project in Users Management. The default project decides which project budget pays for usage that is not tied to a specific project, so spend by people who work across several projects goes to one predictable project budget instead of their personal budget or an arbitrary project.

Changes

  • Users Management (users.md) — new Default Project section:
    • How the default is determined: the explicitly set project, otherwise the user's personal project, otherwise the first of the user's projects by name. Because of this, every user with projects always shows one default.
    • How the default is shown: the Default label on the first badge in the Projects column, and the Default radio column in User Details.
    • How to set it: saved immediately, with no confirmation dialog and no Save button.
    • A permissions table: Admin/Maintainer can change it, Auditor can only view, Project Admins and Users cannot.
    • What happens when the default membership is removed.
    • A note that the Keycloak "Assign Default Project" mapper is a different concept.
    • Also corrects Add a Project Assignment: the dialog has no role selector (users are added as User). The steps now cover the new Set as default toggle and the message shown when the add succeeds but setting the default fails.
  • Budget Management (budget-management/index.md) — new Default Project section under Working with Budgets:
    • A table of which project each request is attributed to: project-owned assets; Marketplace assistants for members and non-members; AI generation of assistants, skills, and workflows; CLI/IDE requests with and without a configured project.
    • The fallback to the personal or default budget when the attributed project has no covering budget, marked in analytics with budget_fallback_from.
    • Timing of default-project changes (about a minute; past spend is not moved).
    • Also adds a link from Budget Priority, a Key takeaways bullet, and a Recommendations row.
  • Cross-references — new row in the Access by Role table and an updated Users card description (project-user-management/index.mdx); a note in Remove a Member (projects.md).
  • Glossary — new Default Project (under D) and Personal Project (under P) entries, cross-linked to the Users Management and Budget Management sections.
  • Screenshots (project-user-management/images/) — all Users Management images touched by this feature are captured from one local demo dataset (Jane Doe, Alex Contractor, Audit Viewer; projects data-platform, marketing, finance), so names are readable and no blurring is needed:
    • replaced: users-list.png (Default marker in the Projects column), user-details-regular.png, user-details-external.png, auditor-user-details-readonly.png (Default column with all radio buttons disabled)
    • new: user-details-default-project.png (close-up of the Default column), add-project-set-default.png (Add Project dialog with Set as default)
  • FAQ — two new entries (how-do-i-set-a-default-project-for-a-user.md, which-project-budget-is-charged-when-i-use-a-marketplace-assistant.md); how-does-budget-priority-work-in-codemie.md extended with which project is used.

Content was checked against the merged code on main of the backend and the UI repositories, not only the ticket text. Where they differ, the docs follow the shipped behaviour. For example, the ticket's "user has no default project" cases are replaced by the personal-project / first-project fallback introduced in EPMCDME-15738.

Testing

  • Tested locally — production build served with docusaurus serve (instead of npm start) and checked with Playwright
  • All pages render correctly (Users, Projects, Project & User Management, Budget Management, Glossary)
  • Images display properly (all images on the changed pages return 200 as PNG)
  • Internal links work (npm run build reports no broken links or anchors; new anchors #default-project, #how-the-default-project-is-determined, #changing-or-removing-the-default-project, glossary #default-project / #personal-project resolve)
  • Sidebar navigation works (n/a — no sidebar changes; content added as sections of existing pages)

Quality Checks

  • npm run check passes (typecheck + lint + commitlint)
  • No MDX compilation errors
  • No raw angle brackets (<text> must be `<text>`)
  • Sidebar references document IDs (not filenames) — n/a, no sidebar changes
  • Images stored locally next to content (docs/user-guide/project-user-management/images/)
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

  • No admin configuration changes: the feature has no own flag and relies on Platform-managed mode (ENABLE_USER_MANAGEMENT) and LiteLLM budgets, which are already documented. No release-note entry is needed.

🤖 Generated with Claude Code

@alezander86 alezander86 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

  1. A new feature is mentioned, but the screenshots have not been updated.
  2. New entities need to be added to the glossary, also in the default project.

@Bondimm
Bondimm force-pushed the docs/EPMCDME-15109-default-project branch from 784a68f to 1ca405d Compare October 16, 2026 13:30
@Bondimm

Bondimm commented Oct 16, 2026

Copy link
Copy Markdown
Contributor Author

@alezander86 thanks for the review, both points are addressed in 1ca405d:

  1. Screenshots — refreshed users-list.png (Default marker in the Projects column) and user-details-regular.png to the current UI, and added user-details-default-project.png (Default column in User Details) and add-project-set-default.png (Add Project dialog with Set as default). Taken on preview; personal names, emails and avatars are blurred.
  2. Glossary — added Default Project (under D, next to Default Integration) and Personal Project (under P), cross-linked to the Users Management and Budget Management sections.

Branch is rebased on current main.

Bondimm and others added 3 commits October 16, 2026 18:46
Documents how Platform Admins and Maintainers assign a user's default
project in Users Management and how the default project decides which
project budget pays for usage that is not tied to a specific project:
Marketplace assistants used by non-members, AI generation, and CLI
requests without a configured project. Covers the derived default
(personal project, then first project by name), the fallback to the
personal/default budget when the project has no budget, and what
happens when the default membership is removed. Adds two FAQ entries
and extends the budget-priority FAQ.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Addresses review feedback on the default project docs:
- Refreshes the Users list and User Details screenshots to the current
  UI, which shows the Default marker in the Projects column.
- Adds screenshots of the Default column in User Details and of the
  Add Project dialog with the Set as default switch.
- Adds Default Project and Personal Project to the glossary.

Personal names, emails, and avatars in the screenshots are blurred.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…oject

Replaces the Auditor view of User Details with the current UI, which
shows the Default column with all radio buttons disabled, and adds it
to the Default Project permissions section. Captured on a local stack
with demo users (no personal data).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Bondimm
Bondimm force-pushed the docs/EPMCDME-15109-default-project branch from 1ca405d to a42d900 Compare October 16, 2026 15:49
@Bondimm

Bondimm commented Oct 16, 2026

Copy link
Copy Markdown
Contributor Author

Follow-up: auditor-user-details-readonly.png is refreshed too (a42d900). It shows the Default column with all radio buttons disabled for an Auditor and is now also used in the Default Project → Permissions section. Captured on a local stack with demo users.

…aset

Replaces the users list, User Details (regular and External user),
Default column, Add Project, and Auditor screenshots with captures from
a single local demo dataset, so all images show the same users and
projects with readable names and no blurring. Also refreshes the
External user screenshot, which still showed the Projects table without
the Default column.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Bondimm

Bondimm commented Oct 17, 2026

Copy link
Copy Markdown
Contributor Author

@alezander86 could you take another look? Your approval was on the first commit; since then:

  • Screenshots (e8a954c): all Users Management images touched by this feature are retaken from one local demo dataset (Jane Doe, Alex Contractor, Audit Viewer; projects data-platform, marketing), so names are readable and no blurring is needed — users list with the Default marker, User Details (regular and External user), a close-up of the Default column, the Add Project dialog with Set as default, and the Auditor read-only view (radio buttons disabled). The External user screenshot previously still showed the Projects table without the Default column.
  • Glossary (6871761): Default Project and Personal Project entries.

Known UI issue visible in the users list screenshot: the Default label wraps mid-word ("Defa / ult") in the Projects badges. That is a UI defect (the marker span has no whitespace-nowrap); I'll refresh the screenshot once it is fixed.

@alezander86
alezander86 merged commit 5d911ac into codemie-ai:main Oct 19, 2026
4 checks passed
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.

2 participants