-
Notifications
You must be signed in to change notification settings - Fork 0
docs: explain Settings navigation and Billing tabs #135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
fdd4db8
a16b3af
84cd40e
33333cc
fe7b43a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,9 @@ import { Callout } from 'fumadocs-ui/components/callout'; | |
| Use this guide to choose a plan and understand each charge. For current account | ||
| details, open [Settings → Billing](https://mogplex.com/settings/billing). | ||
|
|
||
| Use **Billing Settings** for the plan, payments, invoices, and credit purchases. | ||
| Use **Usage** for the inference balance and recent usage costs. | ||
|
|
||
| ## Individual plans | ||
|
|
||
| Each Individual plan includes one named user, parallel agent runs, Storage, and | ||
|
|
@@ -34,7 +37,7 @@ See [Mogplex pricing](https://mogplex.com/pricing) for the public pricing page. | |
| $1 of inference credit pays for $1 of model usage at the model provider price. | ||
| Included credit resets each month. Purchased credit never expires. | ||
|
|
||
| Billing offers these one-time purchases: | ||
| **Billing Settings** offers these one-time purchases: | ||
|
|
||
| - Pay $1 and get $1 of inference credit. | ||
| - Pay $10 and get $10 of inference credit. | ||
|
|
@@ -49,7 +52,7 @@ amount excludes money reserved for work that is still in progress. | |
|
|
||
| To add credit: | ||
|
|
||
| 1. Open **Settings → Billing**. | ||
| 1. Open **Settings → Billing → Billing Settings**. | ||
| 2. Find **Add inference credit** below the current plan. | ||
| 3. Select an amount. | ||
| 4. Complete the Stripe checkout. | ||
|
|
@@ -58,7 +61,7 @@ The new balance appears after Stripe confirms the payment. | |
|
|
||
| ## Hosted usage rates | ||
|
|
||
| Mogplex shows recent usage costs in Billing. These costs use the available | ||
| Mogplex shows recent usage costs in **Billing → Usage**. These costs use the available | ||
| inference-credit balance. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Warning: Billing tab split applied inconsistently in plans-and-billing.mdx The intro now states Billing Settings owns plan/payments/invoices/credit and Usage owns balance and recent usage costs, and two call sites were updated ("Settings → Billing → Billing Settings" for adding credit, "Billing → Usage" for hosted usage rates). The rest of the page still says plain "Billing":
Either qualify each of these with the owning tab or state once near the top that unqualified "Billing" means the Billing Settings tab. Half-qualified references are more confusing than none. |
||
|
|
||
| Mogplex lists each model call after the cost settles. For a code review, the | ||
|
|
@@ -90,19 +93,19 @@ account. Pending work does not use a run slot. | |
| When all slots are in use, new work waits for a slot. A slot becomes available | ||
| when a run finishes or you stop one. | ||
|
|
||
| Billing shows the plan limit as a static entitlement. It does not show a live | ||
| **Billing Settings** shows the plan limit as a static entitlement. It does not show a live | ||
| usage meter. Use the active-run surfaces to see current work and find the | ||
| runs that use slots. | ||
|
|
||
| If your account can buy more parallel agent runs, Billing shows these recurring | ||
| If your account can buy more parallel agent runs, **Billing Settings** shows these recurring | ||
| add-ons: | ||
|
|
||
| | Add-on | Price | | ||
| | --- | ---: | | ||
| | 10 more parallel agent runs | $5 per month, per quantity | | ||
| | 50 more parallel agent runs | $15 per month, per quantity | | ||
|
|
||
| Some accounts cannot buy new parallel-run add-ons. Billing only shows the | ||
| Some accounts cannot buy new parallel-run add-ons. **Billing Settings** only shows the | ||
| actions available for the selected account. | ||
|
|
||
| ## Storage add-ons | ||
|
|
@@ -116,7 +119,7 @@ Storage add-ons increase retained storage. The plan stays the same. | |
| | 50 GB | $60 per month, per quantity | | ||
| | 100 GB | $100 per month, per quantity | | ||
|
|
||
| For each capacity change, Billing shows the new limit, monthly change, amount | ||
| For each capacity change, **Billing Settings** shows the new limit, monthly change, amount | ||
| due now, and effective date before confirmation. Increases take effect after | ||
| payment. Decreases and cancellations take effect at the end of the billing | ||
| period. | ||
|
|
@@ -146,10 +149,10 @@ does not display or store the full card number in the Billing page. | |
|
|
||
| Select **Update payment method** to make changes in Stripe. Mogplex creates an | ||
| invoice for each plan payment, add-on payment, and inference-credit payment. | ||
| Usage charges appear in **Recent usage costs**. They do not produce Stripe | ||
| Usage charges appear in **Usage → Recent usage costs**. They do not produce Stripe | ||
| invoices. They spend credit that is already in the account. | ||
|
|
||
| Billing shows the latest 20 invoices. Select an invoice number to open its | ||
| **Billing Settings** shows the latest 20 invoices. Select an invoice number to open its | ||
| hosted invoice or PDF. Select **View all invoices** to open the complete Stripe | ||
| history. | ||
|
|
||
|
|
@@ -165,7 +168,7 @@ token. | |
|
|
||
| <Callout title="Check the selected account"> | ||
| Billing follows the personal or company account selected in Mogplex. Confirm | ||
| the account name at the top of Billing before you report an invoice that you | ||
| the account name on **Billing Settings** before you report an invoice that you | ||
| cannot find or an incorrect balance. | ||
| </Callout> | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,11 +13,20 @@ surfaces. | |
|
|
||
| | Older route | Current destination | Best doc page | | ||
| | --- | --- | --- | | ||
| | `/settings/billing` | The signed-in user's `/<scope>/settings/billing` page | [Settings](/web/settings) | | ||
| | `/<scope>/settings` | Personal **Account** or team **Members** page | [Settings](/web/settings) | | ||
| | `/<scope>/settings?tab=account`, `?tab=teams`, or `?tab=keys` | The matching `/<scope>/settings/<section>` page | [Settings](/web/settings) | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion: Legacy route map has no row for the new MCP Servers page The new rows cover account, teams, keys, billing, members, models, and audit, but the Settings pages table also introduces MCP Servers at |
||
| | `/<scope>/settings?tab=keys&sub=cli` | `/<scope>/settings/mogplex-keys` for personal accounts | [Settings](/web/settings) | | ||
| | `/<scope>/settings?tab=billing` | `/<scope>/settings/billing`, with checkout return messages preserved | [Settings](/web/settings) | | ||
| | `/<team>/settings?tab=members`, `?tab=models`, or `?tab=audit` | The matching team Settings page | [Settings](/web/settings) | | ||
| | `/<scope>/settings?tab=connections` or `/<scope>/settings#connections` | `/<scope>/connections`, with OAuth and Slack return messages preserved | [Connections and MCP](/configure-and-extend/connections-and-mcp) | | ||
| | `/flows` | `/automations` | [Flows](/web/flows) or [Automations](/web/automations) | | ||
| | `/library` | `/agents/skills` by default, with tab-specific redirects for rules, context, and models | [Library](/web/library) | | ||
| | `/primitives` | `/agents/skills` by default, with tab-specific redirects for rules and context | [Primitives](/web/primitives) | | ||
|
|
||
| **MCP Servers** keeps its route at `/<scope>/settings/mcp`. | ||
| It now has a link in the personal Settings sidebar. | ||
|
|
||
| ## When the old route names still matter | ||
|
|
||
| You will still run into these names when you: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,9 +24,9 @@ the Supabase `ai_models` table by `pnpm gen:models`. | |
|
|
||
| ## Where to see models | ||
|
|
||
| Open [Settings](/web/settings) and use the **Models** section. | ||
| Open **Models** in the main sidebar. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion: models.mdx: dangling antecedent after the sidebar rewording "Open Models in the main sidebar." is now followed by "That section is the product-facing model catalog." With the Settings framing gone, "That section" has no clear referent. Suggest "The Models page is the product-facing model catalog." |
||
|
|
||
| That section is the product-facing model catalog. It shows the models Mogplex | ||
| The Models page contains the model catalog. It shows the models Mogplex | ||
| can currently present to the signed-in account, including: | ||
|
|
||
| - provider | ||
|
|
@@ -122,22 +122,22 @@ provider, model family, or cost profile. | |
|
|
||
| That scope split is: | ||
|
|
||
| - global enabled state in **Settings → Models** | ||
| - global enabled state in **Models** | ||
| - repo-specific exclusions in the repo or space settings | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| | Symptom | Check | | ||
| | --- | --- | | ||
| | No models appear in an agent picker | Open Settings → Models and confirm at least one model is enabled. | | ||
| | No models appear in an agent picker | Open Models and confirm at least one model is enabled. | | ||
| | A model appears but a run fails with access errors | Check the account plan, entitlement state, and model availability. | | ||
| | The CLI signs in but no shared model list appears | Confirm the web account has model access and that the CLI is using account-backed login. | | ||
| | A saved agent references a hidden or stale model | Move it to a visible enabled model in the agent editor. | | ||
| | A repo cannot use a globally enabled model | Check repo settings for a repo-specific model exclusion. | | ||
|
|
||
| ## Read next | ||
|
|
||
| - [Settings](/web/settings) for account preferences, access tokens, and models | ||
| - [Settings](/web/settings) for account access and Mogplex Keys | ||
| - [API → Models](/reference/api#models) for the route contract behind the catalog | ||
| - [Agents](/web/agents) for model choice on reusable agents | ||
| - [CLI → Authentication](/cli/guides/authentication) for account-backed model | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,47 @@ | ||
| --- | ||
| title: Settings | ||
| description: Manage GitHub identity, App coverage, access keys, account preferences, and billing. | ||
| description: Find account and team settings, provider credentials, Mogplex access tokens, and billing. | ||
| --- | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion: settings.mdx frontmatter description and residual single-page framing are now stale Minor cleanups in content/docs/web/settings.mdx:
|
||
|
|
||
| Settings is the account-level control plane for Mogplex. | ||
| Open **Settings** in the sidebar to manage your account or team. | ||
|
|
||
| If something about your identity, repo coverage, model access, or | ||
| CLI sync looks wrong, this is the first page to inspect. | ||
| Settings opens a secondary sidebar. Select a section to open its page. | ||
| Use the back arrow beside **Settings** to return to the main navigation. | ||
| On mobile, open the navigation menu to select a Settings page. | ||
|
|
||
| ## Use this page to fix account problems, not routing logic | ||
| ## Settings pages | ||
|
|
||
| Each section has its own URL. Reloads and bookmarks open the same section. | ||
|
|
||
| | Personal page | Route | | ||
| | --- | --- | | ||
| | Account | `/<scope>/settings/account` | | ||
| | Teams | `/<scope>/settings/teams` | | ||
| | Provider Keys | `/<scope>/settings/keys` | | ||
| | Mogplex Keys | `/<scope>/settings/mogplex-keys` | | ||
| | MCP Servers | `/<scope>/settings/mcp` | | ||
| | Billing | `/<scope>/settings/billing` | | ||
|
|
||
| Team Settings includes **Members**, **Provider Keys**, **Models**, and **Billing**. | ||
| Owners and admins also see **Audit**. | ||
| Each uses the same route pattern, such as `/<team>/settings/models`. | ||
| Personal keys and account preferences stay in the personal scope. | ||
|
|
||
| Each old tab link opens its section's page. | ||
| For example, `?tab=keys&sub=cli` opens **Mogplex Keys**. | ||
|
|
||
| ## Billing | ||
|
|
||
| Open **Settings → Billing** for two tabs: | ||
|
|
||
| - **Billing Settings**: manage the plan, payment method, invoices, inference credit, and available add-ons. | ||
| - **Usage**: view the inference balance and recent usage costs. | ||
|
|
||
| The Usage tab uses `/<scope>/settings/billing?tab=usage`. | ||
| Reloads and browser Back preserve the selected tab. | ||
| Team billing uses the current team and its permissions. | ||
|
|
||
| ## Account setup and workflow setup | ||
|
|
||
| Settings is where you answer questions like: | ||
|
|
||
|
|
@@ -37,41 +70,22 @@ actually support them. | |
|
|
||
| ## What lives here | ||
|
|
||
| Settings currently groups together: | ||
|
|
||
| - **Account** state for GitHub identity, GitHub App coverage, and account | ||
| readiness | ||
| - **Access Tokens** for CLI, API, and script authentication | ||
| - **Preferences** for theme and default model | ||
| - **Run checks**, one switch for the automatic judgments Mogplex makes about | ||
| agent work | ||
| - **Account** shows GitHub identity, App coverage, account access, and **Run checks**. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Warning: Preferences (theme, default model) dropped from the page list but still referenced later The removed list included "Preferences for theme and default model". The new "What lives here" list and the Settings pages table have no Preferences entry, yet the "Preferences and Models" section further down still states "Settings owns account preferences." After the sidebar split, readers need to know which page holds theme and default-model preferences — presumably Account, but the doc does not say. Was the omission intentional? Suggestion: if preferences moved under Account, extend the Account bullet (e.g. "Account shows GitHub identity, App coverage, account access, preferences for theme and default model, and Run checks") and update the "Preferences and Models" section to name the page. |
||
| - **Teams** lists team memberships and controls. | ||
| - **Provider Keys** stores keys for model providers. | ||
| - **Mogplex Keys** manages tokens for CLI, API, and script access. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Warning: Settings doc uses two names for the same surface (Mogplex Keys vs Access Tokens) The "What lives here" list now says "Mogplex Keys manages tokens for CLI, API, and script access", and the pages table adds A reader scanning for "Mogplex Keys" will not find it, and the "Access Tokens" heading now contradicts the navigation the PR is documenting. Suggestion: rename the heading to "Mogplex Keys" with a one-line note that this was previously called Access Tokens, and add a short "Provider Keys" section covering model-provider credentials so both new pages have detail to match the table. |
||
| - **MCP Servers** manages server definitions for CLI sync. | ||
| - **Billing** contains **Billing Settings** and **Usage**. | ||
|
|
||
| **Models** and **Connections** have their own sidebar destinations. | ||
| For model setup, see [Available Models](/web/models). | ||
|
|
||
| For the connection-specific operating guide, see | ||
| [Connections and MCP](/configure-and-extend/connections-and-mcp). | ||
|
|
||
| ## Start at the top of the page first | ||
|
|
||
| The top of Settings is intentionally opinionated. | ||
|
|
||
| It is the part of the product that tells you: | ||
|
|
||
| - whether GitHub is connected at all | ||
| - whether the GitHub App is installed on the right owner | ||
| - whether synced repos exist yet | ||
| - whether billing, model access, or sandbox access still needs action | ||
| - what the next most likely setup step is | ||
|
|
||
| Treat that top block as the “what is missing?” answer before you debug any | ||
| deeper form. | ||
|
|
||
| ## Account section | ||
|
|
||
| The top of Settings is intentionally operational, not decorative. | ||
|
|
||
| It shows: | ||
| The **Account** page shows: | ||
|
|
||
| - current GitHub connection mode and status | ||
| - GitHub App coverage and synced repo counts | ||
|
|
@@ -110,8 +124,8 @@ default. | |
|
|
||
| | Where the work runs | Who decides | Where the switch is | | ||
| | --- | --- | --- | | ||
| | Inside a team | A team owner or admin | Team Settings, **Models** tab | | ||
| | Outside a team | You | Settings, **Account** tab | | ||
| | Inside a team | A team owner or admin | Team Settings, **Models** page | | ||
| | Outside a team | You | Settings, **Account** page | | ||
|
|
||
| Work inside a team always follows the team's setting, never a member's own. | ||
| Every change to a team's setting is written to the team audit log. | ||
|
|
@@ -141,7 +155,7 @@ normal hosted work. If a model picker is empty or a sandbox cannot launch | |
| because access is missing, check the account plan or entitlement state before | ||
| editing agents, prompts, or repo launch settings. | ||
|
|
||
| The Billing section shows the monthly plan cost, next due date, protected card | ||
| The **Billing Settings** tab shows the monthly plan cost, next due date, protected card | ||
| summary, and recent invoices. It also lets an authorized owner or admin update | ||
| the payment method, open the complete invoice history, buy inference credit, | ||
| and manage available capacity add-ons. | ||
|
|
@@ -256,15 +270,20 @@ reply conversationally. In a linked channel, a real instruction after | |
|
|
||
| For the full Slack model, see [Slack](/integrations/slack). | ||
|
|
||
| ## Access Tokens | ||
| ## Provider Keys | ||
|
|
||
| Open **Settings → Provider Keys** to add or remove your own model-provider credentials. | ||
| This page supports AI Gateway, Anthropic, OpenAI, and OpenRouter. | ||
| Personal keys belong to your account. Team keys use the selected team's permissions. | ||
|
|
||
| Access tokens are for authenticating Mogplex clients and scripts. They are not | ||
| model-provider credentials. | ||
| <span id="access-tokens" /> | ||
|
|
||
| Use them when the CLI or another Mogplex-aware script needs to authenticate as | ||
| you against Mogplex itself. | ||
| ## Mogplex Keys | ||
|
|
||
| The section supports: | ||
| Open **Settings → Mogplex Keys** to manage access tokens for Mogplex clients and scripts. | ||
| These tokens authenticate with Mogplex itself. | ||
|
|
||
| The page supports: | ||
|
|
||
| - naming each token | ||
| - optional expiration windows | ||
|
|
@@ -278,8 +297,9 @@ user-supplied provider or sandbox credentials. | |
|
|
||
| ## Preferences and Models | ||
|
|
||
| Settings owns account preferences. Open **Models** in the sidebar to manage | ||
| model access and defaults. | ||
| Open the user menu to change the theme. | ||
| Open **Models** in the main sidebar to manage model access. | ||
| Use **Models → Configuration** to set the primary model and fallbacks. | ||
|
|
||
| The important split is: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Unscoped billing link may not match the new scoped routes
The added tab guidance sits directly under the existing link to
https://mogplex.com/settings/billing, while this PR documents billing as scoped (/<scope>/settings/billing) and the legacy-route table only lists scoped redirects. Please confirm the unscoped/settings/billingURL still resolves after the app deploy; if it only works via a scope-inference redirect, that is worth a row in the legacy table.