Repository navigation
Build the docs from the latest Upshift release - #13
Merged
Merged
Conversation
The public docs were generated from upshift-main, which tracks Twenty's main branch, so they described and were labelled with a version no client could install yet. The site now follows Upshift releases. The importer takes --root to read another Twenty checkout, --version to name the Upshift release it documents (and fail when the sources carry another version), and --check to build without writing. The generated site is no longer committed; a new Upshift Docs workflow builds it from the newest upshift/vX.Y.Z GitHub Release, with Twenty checked out at the matching tag and the rules and overrides of upshift-main, and publishes it to the docs branch that Mintlify deploys. It runs after each Upshift Release run, on pushes to upshift-main that touch the docs or branding, and on demand; pull requests run the build without publishing.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
A branch named docs cannot coexist with the docs/... feature branches, since git stores refs as paths, so the published site lives on docs-site.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
docs.upshiftcloud.com is generated from
upshift-main, which tracks Twenty's main branch. Since #12 the navbar shows that version,v2.47.0, which no client can install yet, while the newest Upshift release is v2.46.0. The public docs must follow Upshift releases.What
import-docs.mjstakes--root <twenty checkout>to read another Twenty checkout,--version X.Y.Zto name the Upshift release it documents (fails when the sources carry another version), and--checkto build without writing.upshift/docs/siteis no longer committed; the folder is ignored. The drift check goes away with it.upshift/vX.Y.ZGitHub Release, checks out Twenty attwenty/vX.Y.Z(sparse), builds the site with the rules and overrides ofupshift-main, and publishes it to thedocs-sitebranch. It runs after each Upshift Release run, on pushes toupshift-maintouchingupshift/docs/**orupshift/branding/**, and on demand. On pull requests it only proves the build. The branch is nameddocs-sitebecause a branch nameddocscannot coexist withdocs/...feature branches.--checkbuild against this branch's Twenty docs, so a Twenty change that breaks a rule shows up before a release.Mintlify
The deployment's git source now points at branch
docs-sitewith an empty content directory, and that branch already carries the v2.46.0 site built with this importer. Nothing deploys fromupshift-mainany more, which is why the Mintlify preview on this PR fails: the PR removes the folder the old source read.Verified
node --test upshift/docs/test/*.test.mjs: 57 passingnode upshift/docs/import-docs.mjs --root <twenty at v2.46.0> --version 2.46.0builds 112 fr + 121 en pages labelledv2.46.0;--version 2.47.0against the same sources fails with "the docs are built for Upshift v2.47.0 but the sources carry 2.46.0"mintlify validate(strict) passes on that build