Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Dec 5, 2025

Summary

Enhances the "Include more than one API Reference" section in the API Reference documentation with:

  • A visual <Files> component diagram showing the recommended apis/ folder structure with plant-store-api and seed-api subfolders (replacing the ASCII tree)
  • A new "Flattened API References" subsection explaining how to use flattened: true to display endpoints without extra nesting
  • Clearer organization with subheadings: Folder structure, Basic configuration, Flattened API References, Using tabs
  • Updated examples to use plant-themed naming consistent with Fern documentation conventions

Review & Testing Checklist for Human

  • Verify the <Files> component diagram renders correctly in the preview
  • Confirm the flattened: true explanation is accurate and consistent with the existing documentation in customize-api-ref.mdx
  • Check that the YAML code examples are syntactically correct and follow docs.yml conventions

Test plan: Open the preview link and navigate to the "Generate API Reference" page, scroll to "Include more than one API Reference" section, and verify the folder diagram displays properly and all code examples are readable.

Notes

…example

Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 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

api-name: seed-api
```

#### Flattened API References
Copy link
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.Headings] 'Flattened API References' should use sentence-style capitalization.

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.

1 participant