docs: renaming objects in Studio#50
Open
rnv812 wants to merge 3 commits into
Open
Conversation
Re-export the OpenAPI schema and generate the pages for the four rename endpoints and the secret-references endpoint. `pnpm generate-api-docs` currently emits `content/docs/api/index.mdx` with an empty card list - reproduced against the unchanged schema on develop, so it predates this change. The index is kept as generated before and the five cards are added in its format. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Describe each rename action where its page already covers the row
actions, including what cascades and what does not: instances follow a
renamed project and must be stopped, a renamed instance keeps its
scenario membership, a scenario tag is rewritten everywhere, and
`${secrets.*}` placeholders keep the old name.
Also corrects the projects row menu description, which listed a
"duplicating" action the menu does not have.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
With `groupBy: 'route'` the generated entries are nested under group entries, and the index builder skips groups - left to its default the overview page came out with an empty card list, dropping every endpoint link. Naming the flattened page paths explicitly keeps a card per endpoint, so `pnpm generate-api-docs` output can be taken as-is again. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Documents the rename actions shipped in eventum-generator/eventum#200 (issue eventum-generator/eventum#174).
Studio pages
${secrets.name}, which keep the old name.TextCursorInputis registered inmdx-components.tsxfor the rename icon used inline.API reference
Re-exported
public/schemas/eventum-openapi.json(the only path-level change is the five new endpoints;info.versionmoves 2.5.0 → 2.6.0) and regenerated the pages.scripts/generate-docs.tsalso needed a fix: withgroupBy: 'route'the generated entries are nested under group entries and the index builder skips groups, so the default configuration produced an overview page with an empty card list — every endpoint link was dropped on regeneration. The script now names the flattened page paths explicitly, andcontent/docs/api/index.mdxis again taken from the generator as-is, carrying a card per endpoint (79 = 74 existing + 5 new).pnpm buildpasses; the rendered overview page carries all 79 links, and the five endpoint pages plus the four Studio pages are in the static output.🤖 Generated with Claude Code