Conversation
Split the Budget Management section into the concept page plus two new sub-pages, and bring the project budget content in line with the current UI. New pages: - Project Budgets: unified Create Budget dialog (single total distributed across Platform/CLI/Premium Models), projects list budget column and filters, live spend tracking, member allocations and overrides, enforce-vs-shared-pool distribution modes, rebalance - Chargeback & Cost Centers: chargeback toggles and attribution targets, cost center management and project assignment Updates: - index.md: project budget section replaced with pointers; budget types and parameters corrected for the single-total flow - project-budget-management.md: cross-links added, over-traversing relative link fixed - sidebars.ts: populate the empty Budget Management items array - FAQ: two new entries; refresh the project budget entry that described the removed per-category Add Budget flow - Replace 3 superseded screenshots with 10 current captures Generated with AI Co-Authored-By: codemie-ai <[email protected]>
PR Preview Ready!Your preview documentation is ready! Visit it here: Preview URL: http://codemie-docs-pr-previews.s3-website.eu-central-1.amazonaws.com/pr-427/
This preview will be automatically updated when you push new commits to this PR. |
Budget Management carried the EnterpriseFeature component in the page body but was missing the sparkle marker used elsewhere to flag enterprise sections in navigation. Apply the same convention as CodeMie CLI: the marker goes on the section entry only (front matter sidebar_label, sidebars.ts label, and the user-guide landing FeatureCard), while child pages keep plain labels and rely on the in-page component. Generated with AI Co-Authored-By: codemie-ai <[email protected]>
The Enterprise Features catalog is the discovery path for Enterprise-only functionality, but nothing in the tech-writer workflow required checking it, so new Enterprise pages could ship unmarked and unlisted — as the budget management pages just did. Enterprise Features catalog: - Extend the Budget Management row for the single-total distribution flow and member allocation modes, and point it at the user guide rather than only the admin configuration page - Add a Chargeback & Cost Centers row under Analytics & Governance tech-writer skill: - Phase 2 research now reports whether sibling pages are marked Enterprise - Phase 4 asks about edition when it is not already clear - New standards section documents both marking parts: the in-page EnterpriseFeature badge on every page, and the sparkle navigation marker on the section entry only, in all three places it appears - QA checklist gates on determining Enterprise status and registering the feature in the catalog Generated with AI Co-Authored-By: codemie-ai <[email protected]>
The badge body read "This is an enterprise feature." directly under a heading reading "Enterprise Feature" — it restated the title and left the reader with nothing to act on. State what the label actually implies: the feature needs an Enterprise Edition license, it may not be enabled on a given deployment, and the platform administrator is who to ask. Link through to the Enterprise Features catalog so the badge is also a way into the full list. Generated with AI Co-Authored-By: codemie-ai <[email protected]>
Drop "Enterprise Edition license" in favour of "CodeMie Enterprise package" in the badge and in the catalog's access note, so both match how the offering is actually named. Also make the catalog note impersonal, matching the house style used elsewhere in the docs. Generated with AI Co-Authored-By: codemie-ai <[email protected]>
Replace the remaining "Enterprise Edition" wording so the docs use one name for the offering throughout: the aiAdoption row and its two YAML comments in the feature configuration reference, and the Enterprise Features page description. No mention of "Enterprise Edition" or "license" remains under docs/ or src/. Generated with AI Co-Authored-By: codemie-ai <[email protected]>
The enterprise guidance added earlier in this branch told writers to say "Enterprise Edition", which would reintroduce the phrasing just removed from the docs. Update the Phase 4 question and the standards section, and state the naming rule outright so it is not guessed at next time. Generated with AI Co-Authored-By: codemie-ai <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents chargeback and cost centers — previously absent from the docs entirely — and brings the project budget content in line with the current UI, based on the Cost Controls walkthrough recording and its captured screens.
Writing those pages surfaced three adjacent gaps, fixed here as well: Budget Management was an Enterprise feature carrying no navigation marker and no catalog entry; the
<EnterpriseFeature />badge said nothing useful; and the docs called the offering an "Enterprise Edition license" rather than the Enterprise package.Changes
Budget documentation
Enable chargeback/Attribute to a cost centertoggles and their attribution targets, cost center management, project assignment, end-to-end departmental rolloutindex.mdtrimmed to concepts (types, categories, priority, enforcement, routing matrix) with pointers to the new sub-pages; budget types and parameters corrected for the single-total flowBudget Managementsidebar category had an emptyitems: []; it now holds both pageshow-do-i-set-a-budget-for-a-project-in-codemie— it described the removed per-category Add Budget flowEnterprise marking
✨marker on its section entry in all three places it belongs (front mattersidebar_label,sidebars.ts, landingFeatureCard), matching the CodeMie CLI pattern. Child pages keep plain labels and rely on the in-page badge<EnterpriseFeature />badge body — it readThis is an enterprise feature.directly beneath a heading reading Enterprise Feature. It now states that the capability may not be enabled on a given deployment, names the platform administrator as who to ask, and links to the catalogdocs/orsrc/tech-writer skill
Nothing in the workflow required checking Enterprise status, which is how these pages shipped unmarked in the first place. Added gates at four points: Phase 2 research reports whether sibling pages are marked; Phase 4 asks about packaging when unclear; a new standards section documents both marking parts and the naming rule; the QA checklist gates on determining status and registering the feature in the catalog.
Testing
npm start— not run; verified via production build instead (see Quality Checks)npm run buildcompiles all MDX without errorbuild/onBrokenLinks: 'throw'andonBrokenAnchors: 'throw'are set, so a clean build proves every link and cross-page anchor resolves. The badge's JSX<Link>is not covered by that setting, so its target route and renderedhrefwere checked against the build output separatelyQuality Checks
npm run checkpasses (typecheck + lint + commitlint)static/img/)markdownlint: 0 errors across 570 files. cspell: 0 issues across 648 files (added
chargeback/showbackto the dictionary).Additional Notes
Three items for reviewer judgment:
Screenshot theme mismatch. The new captures are light-theme from a build whose Administration nav shows 5 items. The retained
admin-users-budget-view.pnginindex.mdis dark-theme production with a fuller nav (Budgets management, Categories management, MCPs management, Providers management). The new pages are internally consistent, but that older image next to them is visibly a different build — worth a reshoot for uniformity.Chargeback semantics are inferred. The source material describes chargeback as marking spend "for internal billing" and rolling it up to a cost center, but shows no billing report or export surface. The toggles and their attribution effect are documented; no reporting destination is claimed, because none could be sourced. If such a view exists, that section needs a paragraph.
Mixed link styles in the Enterprise Features catalog. The rows added or edited here use the
.mdrelative-path form the repo'sCLAUDE.mdcalls for; pre-existing rows use extensionless paths with an extra../level that Docusaurus clamps. Both build clean, but that file is now mixed — normalizing the older rows would be a reasonable separate cleanup.Generated with AI
Co-Authored-By: codemie-ai [email protected]