Skip to content

Commit e78966b

Browse files
Kapil GowruKapil Gowru
Kapil Gowru
authored and
Kapil Gowru
committed
feat: moving more docs over
1 parent fef7ecf commit e78966b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+2406
-99
lines changed

‎fern/assets/styles.css‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@
110110
> a[href*="cli-api-reference"] {
111111
grid-column: 3;
112112
grid-row: 2;
113+
transform: translateY(-32px);
113114

114115
.fern-selection-item-icon {
115116
width: 1.5rem;

‎fern/products/docs/docs.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,6 @@ navigation:
143143
path: ./pages/guides/integrations/feature-flags.mdx
144144
- page: Self-hosted
145145
path: ./pages/guides/integrations/self-hosted.mdx
146-
- page: Changelog
147-
path: ./pages/changelog/overview.mdx
148-
146+
- changelog: ./pages/changelog
147+
icon: fa-regular fa-clock-rotate-left
148+

‎fern/products/docs/pages/changelog/2024-01-24.mdx‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## API Playground Launch
2+
Enable interactive API testing directly in the documentation.
3+
- Added full API request testing capability
4+
- Improved error handling and status code display
5+
- Added support for recursive property rendering
6+
7+
## Enhanced Dark Mode
8+
Multiple improvements to dark mode readability for syntax highlighting, dropdowns, and search results.
9+
10+
```css
11+
/* Dark mode improvements */
12+
[data-theme='dark'] {
13+
--syntax-bg: #1a1a1a;
14+
--dropdown-bg: #2d2d2d;
15+
--search-highlight: #ffd700;
16+
}
17+
```
18+
19+
## Mobile-Friendly Navigation
20+
Comprehensive updates to mobile navigation experience with collapsible and scrolling.
21+
22+
## Search Enhancements
23+
Multiple improvements to the search experience.
24+
- Default and configurable keyboard shortcuts (`Cmd+A`, `/`) for search
25+
- Improved search box sizing
26+
- Added auto-focus functionality
27+
28+
## Performance Optimization
29+
Several performance improvements across the platform.
30+
- Moved FontAwesome to CDN
31+
- Improved search dialog loading
32+
- Optimized static props loading
33+
- Added polyfill DOM parser for server-side TOC rendering

‎fern/products/docs/pages/changelog/2024-02-22.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## WebSocket Support in API Playground
2+
Added real-time WebSocket testing capabilities to the API playground, enabling developers to test streaming and real-time endpoints directly in the documentation. WebSocket connections can now be established, tested, and debugged without leaving the docs.
3+
4+
## Enhanced Code Highlighting
5+
Implemented a new code highlighting system using Shiki for improved syntax highlighting accuracy and performance. The system now supports more languages and provides better dark mode compatibility.
6+
7+
## Feedback System
8+
Introduced a new feedback collection system using Radix UI components for improved accessibility. Users can now provide structured feedback about documentation quality and usefulness directly within the interface.
9+
10+
## Layout Configuration System
11+
Implemented a flexible layout configuration system that allows for custom header, footer, and sidebar arrangements. Documentation can now be customized to match your brand and preferences.
12+
13+
```yaml
14+
layout:
15+
page-width: full
16+
tabs-placement: header
17+
searchbar-placement: header
18+
```
19+
20+
## Custom Styling Support
21+
Added support for custom CSS and scripts, enabling deep customization of documentation appearance and behavior. Organizations can now apply their branding consistently across their documentation.
22+
23+
```yaml docs.yml
24+
css: ./assets/styles.css
25+
```
26+
27+
```css styles.css
28+
/* Custom styles */
29+
.custom-class {
30+
background-color: #f0f0f0;
31+
}
32+
```

‎fern/products/docs/pages/changelog/2024-03-24.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# March 2024
2+
3+
## Virtualized Syntax Highlighting
4+
Implemented performance-optimized code rendering that handles large code blocks efficiently without impacting page performance. Long code samples now load instantly and scroll smoothly.
5+
6+
## Mobile Search Experience
7+
Redesigned the mobile search interface with a sticky search bar and improved results display. Users can now easily search documentation on mobile devices with a native-feeling interface.
8+
9+
## Scrollbar Refinement
10+
Enhanced scrollbar design and behavior across all documentation sections for a more polished look and feel. Scrollbars now adapt to both light and dark themes while maintaining usability.

‎fern/products/docs/pages/changelog/2024-04-20.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Sidebar Navigation Enhancement
2+
Improved sidebar padding and visual hierarchy with refined spacing and typography. The documentation navigation now provides clearer visual structure and better readability.
3+
4+
## Base Path Configuration
5+
Added flexible base path configuration for documentation routing. Organizations can now host documentation under custom paths while maintaining proper navigation.
6+
7+
```yaml docs.yml
8+
instances:
9+
- url: your-site.docs.buildwithfern.com
10+
custom-domain: your-site.com/docs
11+
```

‎fern/products/docs/pages/changelog/2024-05-22.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Advanced Redirects
2+
Implemented a powerful redirects system supporting pattern matching and parameter preservation. Teams can now manage documentation URL structure while maintaining backwards compatibility.
3+
4+
```yaml
5+
redirects:
6+
- source: /v1/api/*
7+
destination: /v2/api/:splat
8+
permanent: true
9+
- source: /guides/:name
10+
destination: /tutorials/:name
11+
```
12+
13+
## API Authorization Handling
14+
Enhanced API authorization handling in the documentation platform. Developers can now test authenticated endpoints more easily with improved token management.

‎fern/products/docs/pages/changelog/2024-06-25.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# June 2024
2+
3+
## RSS Feed Integration
4+
Added support for RSS feeds to keep users updated on documentation changes. Teams can now offer automated notifications for their documentation.
5+
6+
## JSON-LD Enhancement
7+
Implemented structured data support through JSON-LD for improved SEO. Documentation pages now provide richer information to search engines and social platforms.
8+
9+
```json
10+
{
11+
"@context": "https://schema.org",
12+
"@type": "TechArticle",
13+
"headline": "API Authentication Guide",
14+
"datePublished": "2024-06-15",
15+
"technicalAudience": "Software Developers"
16+
}
17+
```
18+
19+
## Image Zoom Controls
20+
Added configurable image zoom functionality with custom triggers and behaviors. Users can now better examine diagrams and technical illustrations in documentation.
21+
22+
```mdx page.mdx
23+
---
24+
no-image-zoom: true
25+
---
26+
```
27+
28+
## Syntax Extension Support
29+
Added support for additional syntax highlighting languages including BAML and Jinja. Documentation can now properly display a wider range of code examples.
30+
31+
```html
32+
<body>
33+
<h1>Available Products</h1>
34+
{% if products %}
35+
<ul>
36+
{% for product in products %}
37+
<li class="product">
38+
<h2>{{ product.name }}</h2>
39+
<p class="price">${{ product.price }}</p>
40+
<p>{{ product.description }}</p>
41+
{% if product.in_stock %}
42+
<p><strong>Status:</strong> In Stock</p>
43+
{% else %}
44+
<p><strong>Status:</strong> Out of Stock</p>
45+
{% endif %}
46+
</li>
47+
{% endfor %}
48+
</ul>
49+
{% else %}
50+
<p>No products are available at the moment.</p>
51+
{% endif %}
52+
</body>
53+
```

‎fern/products/docs/pages/changelog/2024-07-30.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# July 2024
2+
3+
## Meta Image System
4+
Implemented comprehensive meta image support for better social sharing. Documentation pages now display properly when shared on social media platforms.
5+
6+
```yaml
7+
og:image: /assets/og-image.png
8+
og:type: documentation
9+
twitter:card: summary_large_image
10+
twitter:image: /assets/twitter-card.png
11+
```

‎fern/products/docs/pages/changelog/2024-08-20.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# August 2024
2+
3+
## Anchor Link System
4+
Redesigned anchor link handling for improved navigation within documentation pages. Links now account for fixed headers and maintain proper scroll position when opened.
5+
6+
## WCAG Contrast Improvements
7+
Enhanced color contrast throughout the documentation platform for better accessibility. All text and interactive elements now meet WCAG AA standards by default and warnings are shown for any elements that do not meet WCAG AA standards.
8+
9+
## API Page Center Updates
10+
Improved center element positioning and updates for API documentation pages. Content now flows more naturally and maintains position during navigation.
11+
12+
## Streaming Toggle Enhancement
13+
Improved visibility and behavior of streaming response toggles in API playground. Users can now better control and monitor streaming responses.

0 commit comments

Comments
 (0)