Skip to content

docs(general): corrected links to FAQs #2676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mooreds merged 2 commits into from
Dec 4, 2025
Merged

docs(general): corrected links to FAQs #2676

mooreds merged 2 commits into from
Dec 4, 2025

Conversation

@mooreds
Copy link
Contributor

@mooreds mooreds commented Dec 4, 2025 •
edited by coderabbitai bot
Loading

  • updated some broken links

Summary by CodeRabbit

  • Documentation
    • Fixed internal documentation links across multiple pages to point to the correct FAQ sections.
    • Improved heading formatting in FAQ documentation for consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 4, 2025 •
edited
Loading

Walkthrough

Documentation links pointing to FAQ content have been migrated from the introduction directory to the permify-overview directory across multiple docs. A minor heading punctuation correction was also applied to the target FAQ file.

Changes

Cohort / File(s) Change Summary
Internal FAQ link migration
docs/api-reference/schema/write-schema.mdx, docs/getting-started/testing.mdx		 Updated FAQ references to point from ../../introduction/faqs and ../introduction/faqs to their new locations in ../../permify-overview/faqs and ../permify-overview/faqs respectively.
Heading format correction
docs/permify-overview/faqs.mdx		 Corrected FAQ heading punctuation from "How To Manage Schema Changes ?" to "How To Manage Schema Changes?" (removed space before question mark).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • All changes are straightforward link updates and minor formatting fixes with no logic or content modifications
  • Link paths are consistent across the migration (introduction → permify-overview)

Poem

🐰 Links hop to their new homes today,
From introduction to permify's way,
A question mark tightens its stance,
While docs do their documentation dance! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(general): corrected links to FAQs' accurately reflects the main change of updating broken FAQ links across three documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06116c4 and fdf10fb.

📒 Files selected for processing (3)
  • docs/api-reference/schema/write-schema.mdx (1 hunks)
  • docs/getting-started/testing.mdx (1 hunks)
  • docs/permify-overview/faqs.mdx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Analyze (go)
  • GitHub Check: Test with Coverage
  • GitHub Check: Scan Container for Vulnerabilities
🔇 Additional comments (3)
docs/getting-started/testing.mdx (1)

300-300: Link target path corrected. The relative link to the FAQ has been updated to point to the correct directory structure (permify-overview), and the anchor hash aligns with the target heading.

docs/api-reference/schema/write-schema.mdx (1)

25-25: Link target path corrected. The relative link to the FAQ has been updated to point to the correct directory structure (permify-overview). The path traversal (../../) is correct for the file's depth within the docs hierarchy.

docs/permify-overview/faqs.mdx (1)

68-68: Minor style fix applied to heading. The space before the question mark has been removed, following standard punctuation conventions. Markdown anchor generation removes punctuation, so this stylistic change does not affect the anchor (#how-to-manage-schema-changes) that is referenced in other documentation files.

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 and usage tips.

@mooreds mooreds merged commit 87f38d6 into Permify:master Dec 4, 2025
9 of 11 checks passed
@mooreds mooreds deleted the mooreds/update-busted-faq-link branch December 4, 2025 21:01
@codecov
Copy link

codecov bot commented Dec 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.58%. Comparing base (3eb57ec) to head (fdf10fb).
⚠️ Report is 35 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #2676      +/-   ##
==========================================
+ Coverage   82.55%   82.58%   +0.03%     
==========================================
  Files          74       74              
  Lines        8125     8125              
==========================================
+ Hits         6707     6709       +2     
+ Misses        903      902       -1     
+ Partials      515      514       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai coderabbitai bot mentioned this pull request Dec 9, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jan 6, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@mooreds