Skip to content

docs: document password protection dashboard feature#3743

Merged
devalog merged 3 commits intomainfrom
fern/document-password-protection
Feb 24, 2026
Merged

docs: document password protection dashboard feature#3743
devalog merged 3 commits intomainfrom
fern/document-password-protection

Conversation

@paarthfern
Copy link
Copy Markdown
Contributor

@paarthfern paarthfern commented Feb 23, 2026

Summary

Documents the new self-serve password protection feature added to the Fern Dashboard in fern-api/fern-platform#7377. Previously, the password protection docs page directed users to contact Fern — this PR replaces that with step-by-step instructions for the dashboard-based workflow.

Changes:

  • Updated docs/authentication/password.mdx — replaced "contact Fern" setup instructions with dashboard steps (enable, reset, remove), added SEO indexing note
  • Added dashboard/pages/password-protection.mdx — new dedicated dashboard page covering enable/reset/remove flows and permission requirements
  • Updated dashboard/dashboard.yml — added nav entry under Configuration
  • Updated dashboard/pages/overview.mdx — added password protection card to the Setup section

Updates since last revision

  • Fixed Vale lint warnings: used contractions (aren't, won't) instead of full forms per project style rules.

Local Testing

Both pages were verified locally with fern docs dev:

Docs > Authentication > Password protection (/learn/docs/authentication/setup/password-protection):
Password protection docs page

Dashboard > Configuration > Password protection (/learn/dashboard/configuration/password-protection):
Password protection dashboard page

All components (<Steps>, <Note>, <Warning>, <Card>) render correctly and navigation links resolve locally.

Preview deployment: https://fern-preview-ec40e485-ee96-4e5e-a0e1-3e9652e4e887.docs.buildwithfern.com/learn

Review & Testing Checklist for Human

  • Verify the feature is live: The platform PR (#7377) was merged but then reverted (dbdf34adcf). Confirm the dashboard password protection UI is actually deployed before merging these docs.
  • Verify UI descriptions match the actual dashboard: Button labels ("Save", "Reset", "Remove", "Enable"), dialog text, and card placement were inferred from reading the React source code, not from using the live UI. Walk through the dashboard Settings page to confirm accuracy.
  • Verify internal links resolve in preview: Check that /learn/dashboard/configuration/password-protection and /learn/docs/authentication/setup/password-protection work in the preview deployment.

Recommended test plan: Open the preview deployment, navigate to both the Dashboard > Configuration > Password protection page and the Docs > Authentication > Setup > Password protection page, and verify content renders and all links work. Then open the live Fern Dashboard and compare the described UI (button labels, card placement, dialog text) against the actual Settings page.

Notes


Open with Devin

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Protect your published documentation site with a shared password directly from the [Fern Dashboard](https://dashboard.buildwithfern.com/). When enabled, visitors must enter the password before they can view any content.

<Note>
Password-protected sites are not indexed by search engines.
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.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.

When password protection is enabled, visitors to your documentation site are prompted to enter a password before they can view any content. Once authenticated, users can browse the site until their session expires.

<Note>
When password protection is active, search engines will not index your site.
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.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'won't' instead of 'will not'.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 23, 2026

@dsinghvi
Copy link
Copy Markdown
Member

Requested by: devin
Slack thread: View conversation

@@ -0,0 +1,7 @@
## Password protection

You can now enable password protection for your documentation site directly from the Fern Dashboard.
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.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated

@devalog devalog merged commit 9910f75 into main Feb 24, 2026
2 checks passed
@devalog devalog deleted the fern/document-password-protection branch February 24, 2026 18:27
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

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.

4 participants