Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Update file structure displays to use Files component

Summary

Converted all file structure displays throughout the documentation from bash code blocks with tree characters (├─, └─) to the new interactive Files component introduced in PR #1870.

Changes:

  • Updated 37 documentation files across all product sections (Docs, SDKs, API Definitions, CLI Reference)
  • Replaced bash code blocks containing file trees with <Files>, <Folder>, and <File> components
  • Moved inline comments from code blocks to adjacent descriptive text (e.g., bullet points or notes)
  • Used defaultOpen property on root folders and immediate children for better visibility
  • Preserved all file/folder information and hierarchy

Files affected:

  • 3 project structure pages (Docs, SDKs, API Definitions)
  • 9 SDK quickstart guides (TypeScript, Python, Java, Go, Ruby, C#, Swift, PHP, Postman)
  • 3 SDK snippet files (OpenAPI, Fern Definition, AsyncAPI)
  • 8 API definition overview pages (AsyncAPI, OpenAPI, OpenRPC, gRPC, Fern Definition)
  • 6 Fern Definition feature pages (auth, packages, dependencies, etc.)
  • 5 docs configuration pages (versions, products, changelogs, quickstart, reusable markdown)
  • 3 custom component pages (CSS/JS, markdown, API/webhook references)

Review & Testing Checklist for Human

  • Visual rendering verification: Check that Files components render correctly on the preview deployment - especially verify that folders expand/collapse properly and the hierarchy is clear
  • Content accuracy: Spot-check a few converted files to ensure no information was lost during conversion, particularly where inline comments were moved to adjacent text
  • Consistency check: Verify that the conversion pattern is consistent across different file types (some files have "Key files:" sections, others have "Note:" sections - confirm this makes sense contextually)
  • Edge cases: Check the 4 files that still contain └─ characters (pr-preview.mdx, preview-changes-locally.mdx, publishing-your-docs.mdx, commands.mdx) - these should only be CLI output formatting, not file trees that need conversion
  • Empty folders: Verify that empty folders (represented as <Folder name="xyz" />) render correctly in the UI

Recommended test plan:

  1. Deploy to preview environment and navigate through different documentation sections
  2. Verify Files components are interactive (folders can expand/collapse)
  3. Check that the visual hierarchy matches the original bash tree structures
  4. Confirm that explanatory text (bullet points, notes) added alongside Files components is helpful and not redundant

Notes

- Convert bash code blocks with tree characters to Files components
- Update 37 files across documentation
- Move inline comments to adjacent descriptive text
- Use defaultOpen for immediate folder visibility

Co-Authored-By: Devin Logan <[email protected]>
@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

<File name="..." />
</Folder>
<Folder name="versions" defaultOpen>
<Folder name="latest">
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.Current] Avoid time-relative terms like 'latest' that become outdated

@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 2025

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