Skip to content

[DRAFT] TW-1722: Integrate offline Workflow Editor into the docs#5

Open
matenadasdi wants to merge 1 commit intoclaude/festive-shamir-31a238from
tw-1722-offline-workflow-editor
Open

[DRAFT] TW-1722: Integrate offline Workflow Editor into the docs#5
matenadasdi wants to merge 1 commit intoclaude/festive-shamir-31a238from
tw-1722-offline-workflow-editor

Conversation

@matenadasdi
Copy link
Copy Markdown
Collaborator

@matenadasdi matenadasdi commented May 7, 2026

Summary

The offline Workflow Editor was buried on a single Bitrise CLI page titled
"Installing and upgrading...". Users either stumbled across it or didn't know
it existed, even though it offers most of the Workflow Editor functions
without needing a Bitrise login or an internet connection.

Changes:

  • Reframe the page as "Offline Workflow Editor" (sidebar label + title) and
    add value-prop sections: "What you can do with it", "When to use it",
    "Best practices", and "Related topics". Slug stays the same so live URLs
    keep working.
  • Replace the empty "Bitrise CLI" section index with a real overview that
    highlights the offline Workflow Editor as one of the CLIs key uses.
  • Promote the existing inline mention on Workflows overview into a more
    visible :::tip admonition so readers see it on the landing page of the
    Workflows section.
  • Add :::tip admonitions on Creating a Workflow, Adding Steps to a Workflow,
    and the Steps overview, each pointing to the offline Workflow Editor with
    a one-liner about when itll help.
  • Append a :::tip to the "Editing the bitrise.yml file locally" partial,
    which surfaces the offline editor on the "Editing an apps bitrise.yml"
    page (its primary use case: editing the YAML locally).

Follow-up (not in this PR):

  • Update the screenshot at static/img/_paligo/uuid-29b363bc-... with a
    fresh capture from a current build of the offline Workflow Editor.

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

The offline Workflow Editor was buried on a single Bitrise CLI page titled
"Installing and upgrading...". Users either stumbled across it or didnt know
it existed, even though it offers most of the Workflow Editor functions
without needing a Bitrise login or an internet connection.

Changes:

- Reframe the page as "Offline Workflow Editor" (sidebar label + title) and
  add value-prop sections: "What you can do with it", "When to use it",
  "Best practices", and "Related topics". Slug stays the same so live URLs
  keep working.
- Replace the empty "Bitrise CLI" section index with a real overview that
  highlights the offline Workflow Editor as one of the CLIs key uses.
- Promote the existing inline mention on Workflows overview into a more
  visible :::tip admonition so readers see it on the landing page of the
  Workflows section.
- Add :::tip admonitions on Creating a Workflow, Adding Steps to a Workflow,
  and the Steps overview, each pointing to the offline Workflow Editor with
  a one-liner about when itll help.
- Append a :::tip to the "Editing the bitrise.yml file locally" partial,
  which surfaces the offline editor on the "Editing an apps bitrise.yml"
  page (its primary use case: editing the YAML locally).

Follow-up (not in this PR):
- Update the screenshot at static/img/_paligo/uuid-29b363bc-... with a
  fresh capture from a current build of the offline Workflow Editor.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@matenadasdi matenadasdi changed the title [DRAFTTW-1722: Integrate offline Workflow Editor into the docs [DRAFT] TW-1722: Integrate offline Workflow Editor into the docs May 7, 2026
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.

1 participant