Skip to content

fix(docs): build the docs with chronicle 0.16.3 - #1957

Merged
rohanchkrabrty merged 2 commits into
mainfrom
fix-docs-chronicle
Sep 29, 2026
Merged

rohanchkrabrty merged 2 commits into
mainfrom
fix-docs-chronicle

Conversation

@rohanchkrabrty

Copy link
Copy Markdown
Contributor

Summary

  • The Vercel docs build fails on every page with bold or italic text (Maximum call stack size exceeded). bunx resolves dependencies fresh on each build and pulled in mdast-util-to-markdown 2.1.3, which the fumadocs-core pinned by chronicle 0.6.1 can't handle. That's why main and unrelated PRs fail too.
  • Bumps docs/vercel.json to chronicle 0.16.3, which pins the fixed fumadocs-core 16.15.15 (fix: bump fumadocs-core to fix breaking build chronicle#186).
  • Since 0.9.0, chronicle renders the frontmatter title as the page heading, so 47 pages showed their title twice. Removes the leading # … from those pages.
  • Where the body heading differed from the frontmatter title (authn/serviceuser, authn/user, deployment-guide, local-setup), the heading becomes the title, and with it the sidebar label and browser tab.

The docs build fails on every page with bold or italic text:
mdast-util-to-markdown 2.1.3 serialises them through a handler property
that the fumadocs-core pinned by chronicle 0.6.1 drops when it wraps
handlers, so the two recurse until the stack overflows. bunx resolves
the tree fresh on each build, so the new release reached the build
without any change here.

chronicle 0.16.3 pins fumadocs-core 16.15.15, which keeps the property.
Since 0.9.0 chronicle's default theme renders the frontmatter title as
the page heading, so every page that also opened its body with an H1
showed its title twice.

Remove the leading H1 from those pages. Where it differed from the
frontmatter title, the H1 was the title the page stated for itself, so it
becomes the frontmatter title and with it the sidebar label and browser
tab.
@vercel

vercel Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
frontier Ready Ready Preview Sep 28, 2026 5:37pm UTC

@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: raystack/frontier/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: e8aab768-1cdd-446f-a396-74e0d782817b

📥 Commits

Reviewing files that changed from the base of the PR and between 52db5ba and 5eb51c5.

📒 Files selected for processing (48)
  • docs/content/docs/admin-portal.mdx
  • docs/content/docs/admin-settings.mdx
  • docs/content/docs/authn/introduction.mdx
  • docs/content/docs/authn/org-domain.mdx
  • docs/content/docs/authn/serviceuser.mdx
  • docs/content/docs/authn/session.mdx
  • docs/content/docs/authn/user.mdx
  • docs/content/docs/authz/custom-resources.mdx
  • docs/content/docs/authz/disable-vs-delete.mdx
  • docs/content/docs/authz/overview.mdx
  • docs/content/docs/authz/permission.mdx
  • docs/content/docs/authz/policy.mdx
  • docs/content/docs/authz/role.mdx
  • docs/content/docs/basics.mdx
  • docs/content/docs/billing/billing_customers.mdx
  • docs/content/docs/billing/billing_subscriptions.mdx
  • docs/content/docs/billing/introduction.mdx
  • docs/content/docs/concepts/architecture.mdx
  • docs/content/docs/concepts/glossary.mdx
  • docs/content/docs/configurations.mdx
  • docs/content/docs/contribution/contribute.mdx
  • docs/content/docs/deployment-guide.mdx
  • docs/content/docs/index.mdx
  • docs/content/docs/installation.mdx
  • docs/content/docs/local-setup.mdx
  • docs/content/docs/prospects/introduction.mdx
  • docs/content/docs/reconcile.mdx
  • docs/content/docs/reference/api-auth.mdx
  • docs/content/docs/reference/api-definitions.mdx
  • docs/content/docs/reference/billing-configurations.mdx
  • docs/content/docs/reference/cli.mdx
  • docs/content/docs/reference/configurations.mdx
  • docs/content/docs/reference/metaschemas.mdx
  • docs/content/docs/reference/shell-autocomplete.mdx
  • docs/content/docs/reference/smtp.mdx
  • docs/content/docs/reference/webhook.mdx
  • docs/content/docs/sdk/web/admin/components.mdx
  • docs/content/docs/sdk/web/admin/overview.mdx
  • docs/content/docs/sdk/web/admin/utilities.mdx
  • docs/content/docs/tenants/managing-resource.mdx
  • docs/content/docs/tenants/org.mdx
  • docs/content/docs/tenants/project.mdx
  • docs/content/docs/tour/creating-user.mdx
  • docs/content/docs/tour/intro.mdx
  • docs/content/docs/tour/setup-idp-oidc.mdx
  • docs/content/docs/users/group.mdx
  • docs/content/docs/users/principal.mdx
  • docs/vercel.json
💤 Files with no reviewable changes (43)
  • docs/content/docs/concepts/architecture.mdx
  • docs/content/docs/admin-portal.mdx
  • docs/content/docs/billing/introduction.mdx
  • docs/content/docs/reference/billing-configurations.mdx
  • docs/content/docs/prospects/introduction.mdx
  • docs/content/docs/authn/session.mdx
  • docs/content/docs/users/group.mdx
  • docs/content/docs/users/principal.mdx
  • docs/content/docs/reconcile.mdx
  • docs/content/docs/tenants/project.mdx
  • docs/content/docs/concepts/glossary.mdx
  • docs/content/docs/sdk/web/admin/utilities.mdx
  • docs/content/docs/reference/configurations.mdx
  • docs/content/docs/authz/role.mdx
  • docs/content/docs/configurations.mdx
  • docs/content/docs/sdk/web/admin/components.mdx
  • docs/content/docs/sdk/web/admin/overview.mdx
  • docs/content/docs/authn/org-domain.mdx
  • docs/content/docs/reference/cli.mdx
  • docs/content/docs/tenants/org.mdx
  • docs/content/docs/authz/permission.mdx
  • docs/content/docs/authn/introduction.mdx
  • docs/content/docs/reference/webhook.mdx
  • docs/content/docs/tenants/managing-resource.mdx
  • docs/content/docs/installation.mdx
  • docs/content/docs/reference/metaschemas.mdx
  • docs/content/docs/authz/custom-resources.mdx
  • docs/content/docs/authz/overview.mdx
  • docs/content/docs/billing/billing_subscriptions.mdx
  • docs/content/docs/billing/billing_customers.mdx
  • docs/content/docs/reference/shell-autocomplete.mdx
  • docs/content/docs/authz/disable-vs-delete.mdx
  • docs/content/docs/basics.mdx
  • docs/content/docs/index.mdx
  • docs/content/docs/tour/setup-idp-oidc.mdx
  • docs/content/docs/admin-settings.mdx
  • docs/content/docs/tour/creating-user.mdx
  • docs/content/docs/tour/intro.mdx
  • docs/content/docs/reference/api-auth.mdx
  • docs/content/docs/reference/api-definitions.mdx
  • docs/content/docs/authz/policy.mdx
  • docs/content/docs/contribution/contribute.mdx
  • docs/content/docs/reference/smtp.mdx

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Removed redundant headings across the documentation, allowing page content to begin sooner while preserving page titles.
    • Clarified titles for the service user authentication, user authentication, deployment guide, and local setup pages.

Walkthrough

Documentation pages remove leading H1 headings, and four pages update their frontmatter titles. The Vercel build command updates its Chronicle package version from 0.6.1 to 0.16.3.

Changes

Documentation page titles

Layer / File(s) Summary
Remove duplicate page headings
docs/content/docs/**/*.mdx
Documentation pages remove leading H1 headings. Four pages update their frontmatter titles while removing the matching H1. Other page content remains unchanged.

Vercel build command

Layer / File(s) Summary
Update Chronicle version
docs/vercel.json
The build command updates Chronicle from 0.6.1 to 0.16.3. The build action and Vercel preset remain unchanged.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 5eb51

The docs remove duplicate headings and update the Vercel build tool. No concrete current build failure or user-facing documentation defect is established, so the demonstrated merge risk is minimal.

Architecture Summary

Architecture risk: 🔵 Low · up to 5eb51

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 48 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/content/docs/admin-portal.mdx: Removed the Admin Portal level-one heading.
  • observed — Modified behavior in docs/content/docs/admin-settings.mdx: Removed the Platform Preferences Markdown heading.
  • observed — Modified behavior in docs/content/docs/authn/introduction.mdx: The # Overview heading was removed.
  • observed — Modified behavior in docs/content/docs/authn/org-domain.mdx: The Domain Whitelisting heading was removed.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 36459388454

Coverage remained the same at 52.385%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 41180
Covered Lines: 21572
Line Coverage: 52.38%
Coverage Strength: 17.05 hits per line

💛 - Coveralls

@rohanchkrabrty
rohanchkrabrty merged commit cefc54a into main Sep 29, 2026
8 checks passed
@rohanchkrabrty
rohanchkrabrty deleted the fix-docs-chronicle branch September 29, 2026 05:38

This branch was successfully deployed

1 active deployment
Preview — 5eb51c54 Deployed Sep 28, 2026 by vercel[bot]
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.

3 participants