docs: add error message strings to relevant feature pages#4980
Draft
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Draft
docs: add error message strings to relevant feature pages#4980devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Conversation
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| The `url` is missing a subdomain or uses an unexpected shape. Use `<your-org>.docs.buildwithfern.com` (for example, `plantstore.docs.buildwithfern.com`). Don't include `https://`. | ||
| </Accordion> | ||
| <Accordion title='Invalid domain in URL "X". The URL must end with one of: docs.buildwithfern.com, docs.dev.buildwithfern.com'> | ||
| The `url` doesn't end with a supported Fern domain. Update the `url` to end with `docs.buildwithfern.com`. Configure your vanity domain separately with `custom-domain`. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'separately' if it's not important to the meaning of the statement.
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1776387241-docs-error-strings.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
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
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.
Summary
Adds "Common errors" sections to existing docs feature pages so users can paste an error string from
fern check/fern generate --docsinto docs search (or a search engine) and land on the right page. Per Devin's guidance in the Slack thread, errors live alongside the relevant feature rather than in a standalone troubleshooting page.Errors were pulled from the fern CLI docs validator rules (
packages/cli/yaml/docs-validator/src/rules/*) and thegenerate/generateDocsWorkspacecommand. Each accordion quotes the user-facing error string in its title and explains the fix.Pages updated:
seo/redirects.mdx— missing-redirects (moved/removed), circular-redirects (self-loop, chain)navigation/tabs.mdx— tab not declared, tab has bothhref+layout, tab missing any targetnavigation/frontmatter.mdx—Failed to parse frontmatter(inline<Info>next to the Special characters table)authentication/rbac.mdx— role used but not declaredpreview-publish/setting-up-your-domain.mdx— threeInvalid URL ...variants forinstances[].urlpreview-publish/preview-changes-locally.mdx—No docs.yml file found, broken link, invalid URL,Path ... does not existpreview-publish/publishing-your-docs.mdx—No token found ..., OpenAPI spec validation failureScope is intentionally "docs only, to start" — SDK and other error surfaces are not covered here.
Review & Testing Checklist for Human
valid-markdown-link,missing-redirects-logic,valid-instance-url,all-roles-must-be-declared,tab-with-href,filepaths-exist,valid-frontmatter,generateDocsWorkspace), but I didn't run the CLI against a broken fixture to confirm the exact casing/punctuation users see.setting-up-your-domain.mdx, verify the listed valid domains (docs.buildwithfern.com,docs.dev.buildwithfern.com) match the fullVALID_FERN_DOMAINSlist in the validator. I used two examples; the real list may differ./learn/cli-api-reference/cli-reference/commands#fern-generateand/learn/docs/writing-content/markdown-basics#link-format. Other anchors used (#fern-token) already appeared elsewhere in the repo.→). If any look off in preview, the title attribute may need different quoting.Test plan: open the preview URL, visit each updated page, expand each new accordion, and confirm content renders and internal links work.
Notes
fern checkon the branch surfaces the same 2 pre-existing SDK errors asmain(CreateCodeRecordRequest/CreateDocumentRequestalready declared) — unrelated to this PR.Link to Devin session: https://app.devin.ai/sessions/7b48f89348e04d43bf5d6518e7f9939a
Requested by: @devalog