docs: document reserved folder names (fern, apis, changelog) #3597
+21
−6
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 documentation clarifying that the
fern,apis, andchangelogfolders are reserved names and must be named exactly as shown. Also clarifies thatpagesandassetsare not reserved and can use any name. Changes span three pages:project-structure.mdx: New "Reserved folder names" section with a table and warning callout, placed after the top-level folders list. Also adds a sentence in the Multiple APIs accordion reinforcing thatapismust use that exact name. Clarifies in the top-level folders list thatpagesandassetscan use any name.changelogs.mdx: Adds a sentence to the intro paragraph noting thechangelogfolder naming requirement.project-structure.mdx: Adds a sentence to the "Multiple APIs" section noting that theapisfolder must use that exact name.Review & testing checklist for human
pagesandassetscan truly be named anything — this is stated as fact and could mislead users if incorrect/learn/docs/configuration/changelogs) resolves correctly on the preview siteapissentence reads naturally in contextSuggested test plan: Open each of the three preview pages linked below and read through the new/changed content to confirm accuracy and that it flows well with the surrounding text.
Notes
Requested by: Fern Support
Link to Devin run