Skip to content

feat(docs): update getting started and studio section in docs#25

Open
janelletam wants to merge 7 commits into
janelle/docs-v2/visual-differencesfrom
janelle/docs-v2/get-started-migration
Open

feat(docs): update getting started and studio section in docs#25
janelletam wants to merge 7 commits into
janelle/docs-v2/visual-differencesfrom
janelle/docs-v2/get-started-migration

Conversation

@janelletam
Copy link
Copy Markdown
Contributor

@janelletam janelletam commented May 29, 2026

Summary

  • Fix bold formatting issues and icon naming inconsistencies across migrated MDX files
  • Fix mismatched ordering for Get Started section from legacy docs to docs-v2

Test plan

  • Verify all Get Started pages render without errors (configure-your-workspace, human-handoff, inspect, knowledge, monitor, preview, control-access)
  • Verify Studio concept pages render correctly (actions, bot-settings, autonomous-node, translate, different-an-models)
  • Check that bold text and icons display correctly inline

@janelletam janelletam changed the base branch from master to janelle/docs-v2/visual-differences May 29, 2026 14:26
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 29, 2026

Greptile Summary

This PR updates the "Getting Started" section of the docs with consistent formatting improvements and a few content fixes. Icons are moved outside of bold markdown markers across all affected pages, and badge variants are updated from the generic outline to semantic plus/team values.

  • Navigation reorder (bach.config.ts): configure-your-workspace is repositioned to the end of the get-started section, and monitor / edit-appearance swap positions within "Manage your agent".
  • Content fixes (configure-your-workspace.mdx): The previously-flagged duplicate "Developer" row is corrected to "Admin" with the proper permission description.
  • Human Handoff notice (human-handoff.mdx): A Warning callout is added to direct new-workspace users to Botpress Desk, while existing workspace users are told to follow the legacy HITL steps.
  • Webchat link (translate.mdx): The bare /webchat/ link is updated to the more specific /webchat/get-started/introduction.

Confidence Score: 5/5

Safe to merge — all changes are documentation formatting and content fixes with no logic involved.

The diff is entirely documentation: icon placement normalization, badge variant corrections, a new informational Warning callout, a sidebar reorder, and a fixed role-name typo. There are no code paths, API calls, or data mutations to reason about.

No files require special attention.

Important Files Changed

Filename Overview
bach.config.ts Sidebar navigation reordered: configure-your-workspace moved after the Manage your agent group; monitor and edit-appearance swapped within that group. Clean structural change.
src/content/docs/get-started/configure-your-workspace.mdx Icon formatting normalized (icons moved outside bold markers), badge variants updated to semantic values (plus, team), and the duplicate Developer → Admin row in the permissions table corrected.
src/content/docs/get-started/manage-your-agent/human-handoff.mdx Added a Warning callout directing new-workspace users to Botpress Desk; imported Warning from callouts, updated badge variant to plus, and normalized icon placement. Second paragraph inside the Warning is unindented relative to the first.
src/content/docs/studio/guides/how-to/translate.mdx Internal Webchat link updated from bare /webchat/ to /webchat/get-started/introduction for a more specific anchor.
src/content/docs/get-started/manage-your-agent/control-access.mdx Removed description frontmatter field; normalized icon placement in the Settings step.
src/content/docs/get-started/manage-your-agent/preview.mdx Icon placement normalized in both step instructions; no logic changes.
src/content/docs/studio/concepts/actions.mdx Icon placement normalized across three locations; no content changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    GS[Get Started section]
    GS --> QS[quick-start]
    GS --> MAA[Manage your agent]
    MAA --> PRV[preview]
    MAA --> MON[monitor ← moved up]
    MAA --> KNW[knowledge]
    MAA --> INS[inspect]
    MAA --> HH[human-handoff]
    MAA --> EA[edit-appearance ← moved down]
    MAA --> CA[control-access]
    GS --> CW[configure-your-workspace ← moved to end]

    style MON fill:#d4edda
    style EA fill:#fff3cd
    style CW fill:#d4edda
Loading

Reviews (2): Last reviewed commit: "fix(docs): add back missing descriptions" | Re-trigger Greptile

Comment thread .claude/commands/docs-migrator.md
@janelletam janelletam force-pushed the janelle/docs-v2/get-started-migration branch 3 times, most recently from f75fee7 to 84d2aef Compare May 29, 2026 16:03
@janelletam
Copy link
Copy Markdown
Contributor Author

@greptileai

@janelletam janelletam force-pushed the janelle/docs-v2/get-started-migration branch from 051645f to 304c366 Compare May 29, 2026 18:37
@janelletam janelletam force-pushed the janelle/docs-v2/visual-differences branch from 0865088 to 68902b5 Compare May 29, 2026 18:37
@janelletam janelletam changed the title feat(docs): update getting started section in docs feat(docs): update getting started and studio section in docs May 29, 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