Skip to content

docs(SOL-316): host the legacy unified apis moved from docs - #397

Merged
faisalreza-stackone merged 4 commits into
mainfrom
sol-316/migrate-legacy-docs-to-hub
Aug 14, 2026
Merged

docs(SOL-316): host the legacy unified apis moved from docs#397
faisalreza-stackone merged 4 commits into
mainfrom
sol-316/migrate-legacy-docs-to-hub

Conversation

@faisalreza-stackone

@faisalreza-stackonefaisalreza-stackone commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Moves the Legacy Unified APIs documentation here from the docs repo, so it stays available for existing integrations while the main documentation site moves on. Pairs with StackOneHQ/docs#1083, which removes the same content and redirects the old URLs here.

Merge this one first. The docs pull request points docs.stackone.com at these pages, so if that merges first those redirects lead nowhere.

Ticket: SOL-316

What moved

Pages271 across legacy-unified-apis/, hris/, ats/, crm/, lms/, accounting/ and integration-guides/
API reference193 generated pages, plus the 5 per-category OpenAPI specifications that live inside each api-reference/ folder
Snippets27. Eight moved outright, seven were copied because the docs repository still uses them for iam/, documents/ and permissions-check/
Images361. Sixty-five were already here and identical, so those were left alone

Every page kept its path, so docs.stackone.com/hris/introduction becomes hub.stackone.com/hris/introduction.

Navigation

A new Legacy Unified APIs tab, with one anchor per category. The existing three pages stay in a Hub Guides tab, and the 82 existing redirects are untouched.

Keeping the API reference current

scripts/update-oas.ts is ported from the docs repository and scoped to the five categories that moved, with a daily oas-update.yml workflow that opens a pull request when the specifications change. The docs repository dropped those five from its own copy, so the two jobs do not overlap.

This adds a package.json and lock file to a repository that had neither, because the workflow runs npm ci.

Two things worth a look

Three pages were already broken before this move.integration-guides/ats/sapsuccessfactors-assessment, integration-guides/ats/teamtailor-partner-api and integration-guides/lms/external-content-providers/workday each had <Frame> blocks split across lines inside markdown table cells, which MDX cannot parse, so all three failed to build and returned a not-found error on docs.stackone.com. Verified by validating the untouched originals from the docs repository, which fail identically. Fixed by collapsing 21 of those blocks to inline images, the only image form a table cell accepts.

A self-referencing link is fixed. The webhooks snippet said "start with the main Webhooks guide" and linked to the page it renders on. It now points at the current Webhook Events guide.

Checks

  • mint validate passes
  • mint broken-links reports no broken links
  • All 266 navigation entries resolve to a file, and every snippet and image reference resolves
  • Replayed the ported page-path logic against the five specifications: all 193 api-reference paths match the migrated files exactly

Note for reviewers

Running any mint command in two documentation repositories at the same time is unreliable, because ~/.mintlify/mint is a shared working directory and the second run switches which project the first one serves.

🤖 Generated with Claude Code

- 271 pages: legacy-unified-apis, hris, ats, crm, lms, accounting, integration-guides
- includes 193 generated api-reference pages + the 5 per-category openapi specs
- 27 snippets: 8 moved, 7 forked (docs still uses them for iam/documents/permissions-check)
- 361 images; 2 renamed where hub-docs already had a different file at that path
- nav: new Legacy Unified APIs tab using anchors per category
- port scripts/update-oas.ts + oas-update.yml, scoped to the 5 moved categories
- legacy notice snippet on all 6 entry pages
- fix 21 pre-existing <Frame>-in-table-cell parse errors that broke 3 pages
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
CopilotAI lite review requested due to automatic review settings August 11, 2026 13:34
@mintlify

mintlifyBot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

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

ProjectStatusPreviewUpdated (UTC)
stackone-hub🟢 ReadyView PreviewAug 11, 2026, 1:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

faisalreza-stackoneand others added 2 commits August 11, 2026 14:42
- ATS, CRM, LMS, Accounting each get a parent group rooted at their introduction
- group names taken from each page's own title, so they cannot drift
- API Reference stays a sibling of the parent group, as on HRIS
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- recruitee: #partnership-requirements -> #partner-requirements
- sapsuccessfactors assessment + background check: 3 anchors pointed at
<Accordion> titles, which get no anchor, so repoint them at the enclosing heading
- docebo: the tin can blog post 404s, link the Tin Can API spec instead
All four predate the move and are broken on docs today.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Replaces the 404ing tin can blog post with the Docebo help centre article.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@mstrivensmstrivens left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@faisalreza-stackone
faisalreza-stackone merged commit 3ab4c65 into mainAug 14, 2026
2 checks passed
Sign up for freeto 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.

3 participants

@faisalreza-stackone@mstrivens