Skip to content

[Docs] Consolidate duplicated Custom Action content - #878

Draft
lisa-tarbo wants to merge 9 commits into
mainfrom
team-developer-custom-action
Draft

lisa-tarbo wants to merge 9 commits into
mainfrom
team-developer-custom-action

Conversation

@lisa-tarbo

@lisa-tarbo lisa-tarbo commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

Summary: what and why

Consolidates developer custom-action content into the existing Tech-Hub page to remove duplication.

Context

During creating docs for new Team Settings UI, identified there were two pages with similar content which was a maintenance burden.

resolves issue: #797

Changes

Scope

  • Removed recently added concepts/team/custom_actions.md; merged its content into tech-hub/custom_action/index.md

Affected pages / sections

  • Page(s) / section(s): Team Settings (members, integrations, feature flags, data migration, developer/custom actions), FAQ
  • Folder(s):
    • docs/tutorials/
    • docs/how-to/
    • docs/concepts/
    • docs/tech-hub/
Team Settings menu structure 2

Decisions and what was not addressed in this PR

Validation

  • This follows the relevant page-type contract.
  • Examples and UI features/behavior were manually checked.
  • Internal links and cross-references were manually reviewed for user value.
  • Terminology matches current OCS naming and behavior.
  • Validation commands run are listed below:
    • uv run zensical build --clean
    • uv run prek run markdownlint-cli2 --all-files
    • uv run prek run --all-files
    • uv run pytest scripts/tests — 27 passed, 1 pre-existing failure unrelated to this branch (test_update_confluence_release.py, missing RELEASE_URL env var; this branch doesn't touch scripts/)

Risks / notes

  • The mkdocs menu names for sections match the UI menu (e.g. Members) and not the section names (e.g. "Members & access" to help readers match docs menu to the UI.

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Oct 2, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: a75a77d5-48d5-45eb-a51a-76d646714a64

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@lisa-tarbo lisa-tarbo changed the title [Docs] Document new Team Settings UI and consolidate developer custom actions [Docs] Consolidate duplicate custom action pages Oct 2, 2026
@lisa-tarbo
lisa-tarbo marked this pull request as draft October 2, 2026 14:00
@claude

claude Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Documentation review

Overall this is in good shape. The custom-actions consolidation is clean — I diffed the deleted concepts/team/custom_actions.md against the merged tech-hub/custom_action/index.md and nothing of substance was dropped or duplicated, and a tree-wide grep for custom_actions.md, manage_flags_button, and manage_flags_page turns up zero remaining references. The two docs/changelog.md edits are link retargets to the surviving page, which is the right call for keeping historical entries building under strict: true. The new how-to/download_team_files.md follows the how-to contract closely (prerequisites → steps → expected outcome → common issues). Nav covers all three new pages and no entry points at a deleted file.

Two things worth fixing, both minor.

1. Inconsistent naming for the Data section

mkdocs.yml:176 labels the nav entry Data, but the page H1 (docs/concepts/team/data_migration.md:1) is Data & Migration, and docs/concepts/team/index.md refers to it as Data at line 16 and Data & Migration at lines 43, 45, and 54. Every sibling section added in this PR (Members, Developers, Feature Flags) has nav label == H1.

There are also two casings in play: Data & Migration for the doc title and Data & migration for the UI label. If that is deliberate — UI label vs. page title — fine, but then mkdocs.yml:176 and concepts/team/index.md:16 should still match the H1 rather than being the only two places that say plain Data.

Related: docs/tech-hub/migrate_team.md:56 reads "open the Data section, headed Data & migration", which is awkward because it is compensating for the same ambiguity. Once the naming is settled, this can just name the section once.

2. Indirect link

docs/concepts/team/data_migration.md:28 — "To keep a copy of the team's files, download them" sends the reader to a section two lines long whose only content is another link to how-to/download_team_files.md. Linking straight to the how-to saves a hop.

Validation

I could not run uv run zensical build --clean or uv run prek run markdownlint-cli2 --all-files — uv is not available in this environment. The PR description reports both passing, and CI runs the same build, so this is just a note that I did not independently confirm it. I did manually check every internal link and anchor touched by the diff (#downloading-team-files, #migrating-to-another-instance, #deleting-a-team, #enabling-actions-for-a-chatbot, plus the cross-file links in developer.md, index.md, migrate_team.md, and download_team_files.md) and all resolve to real files and headings.

Not findings, for the record

  • data_migration.md describes behavior rather than giving steps, so it sits correctly in concepts/ even though it covers the delete flow — the one genuinely procedural piece (downloading files) was correctly split out into how-to/.
  • No mannered prose in the changed files.
  • I could not verify UI claims against the OCS source (no access to that repo here): the Migration mode control living in the Data section, the 2FA column behavior in members.md, and the (alpha)/(beta) markers in feature_flags.md. Worth a spot-check against the live UI if that has not already been done.

@lisa-tarbo lisa-tarbo changed the title [Docs] Consolidate duplicate custom action pages [Docs] Consolidate duplicated Custom Action content Oct 3, 2026

This branch has not been deployed

No deployments
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