Skip to content

docs: add page on adopting a naming convention for existing flows - #489

Merged
dangrondahl merged 2 commits into
mainfrom
docs/naming-conventions-existing-flows
Nov 3, 2026
Merged

dangrondahl merged 2 commits into
mainfrom
docs/naming-conventions-existing-flows

Conversation

@dangrondahl

Copy link
Copy Markdown
Contributor

Summary

  • Adds implementation_guide/phase_2/plan_organizational_structure/naming_conventions/existing_flows.md covering how to move flows already in use onto a naming convention: rename rather than recreate, how the old name behaves after a rename, rollout order, trail-name caveats, and limits.
  • Adds the page to the Naming Conventions group in config/navigation.json, after Flows and Trails.
  • Links from the Flows and Trails page to the new page, and fixes two relative CLI links on that page to root-relative paths.

The "how the old name behaves" section mirrors the kosli rename flow long description from kosli-dev/cli#1322.

Closes #487

Validation

  • mint broken-links: no broken links
  • pytest tests/: 65 passed

@dangrondahl
dangrondahl requested a review from a team as a code owner November 3, 2026 10:17
@mintlify

mintlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
kosli 🟢 Ready View Preview Nov 3, 2026, 10:17 AM

@claude

claude Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @dangrondahl's task in 1m 56s —— View job


Follow-up review complete

  • Fetch previous review comments and new commits
  • Evaluate status of each previous finding
  • Check changed lines for new issues
  • Post inline notes on resolved threads
  • Post summary comment

Previous finding 1 (archived-flow naming contradicted the tutorials) — resolved. The "Limits" bullet in existing_flows.md now says archiving renames the flow to <name>-archived-at-<timestamp> and that Kosli remembers the original name to reject stale auto-creates, matching the two tutorial callouts instead of contradicting them.

Previous finding 2 (kosli list trails wording) — resolved, applied exactly as suggested ("act on the renamed flow").

1 new inline comment: the rewrite introduces a specific quoted error string and a "kosli create flow still succeeds and takes the name over" claim that aren't corroborated elsewhere in the repo — worth confirming against the CLI source before merging.

Summary comment: #489 (comment)
(branch)

@claude

claude Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Follow-up review of commits a6b68b8..81b4067

Previous finding 1 (archived-flow naming contradiction with tutorials) — resolved. The "Limits" bullet was rewritten to say archiving renames the flow to <name>-archived-at-<timestamp> and that Kosli remembers the original name to reject stale auto-creates, which now matches the two tutorial callouts instead of contradicting them.

Previous finding 2 (kosli list trails wording) — resolved, applied exactly as suggested ("act on the renamed flow").

New inline comment (1): the rewritten bullet adds a specific quoted error string and a "kosli create flow still succeeds and takes the name over" claim that aren't backed up elsewhere in this repo (e.g. client_reference/kosli_archive_flow.md doesn't mention this path) — worth confirming against the CLI source before merging, since a wrong quoted error message would be a new accuracy issue even though the original contradiction is fixed.

@dangrondahl
dangrondahl merged commit 90e1769 into main Nov 3, 2026
5 of 6 checks passed
@dangrondahl
dangrondahl deleted the docs/naming-conventions-existing-flows branch November 3, 2026 10:45
dangrondahl added a commit that referenced this pull request Nov 3, 2026
…490)

## Summary

The publishing log for #489 reported:

```
Failed to parse page content at path implementation_guide/phase_2/plan_organizational_structure/naming_conventions/existing_flows.md: Expected a closing tag for <name> (61:270-61:276) before the end of paragraph
```

The quoted error message in the Limits section contained a bare `<name>`
placeholder inside double quotes, which MDX reads as an unclosed JSX
tag. This wraps the quoted error in a code span, matching the
`<name>-archived-at-<timestamp>` placeholder earlier in the same
sentence, which already uses one.

Follow-up to #489.
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.

implementation_guide: add a page on adopting a naming convention for existing flows

2 participants