Skip to content

Commit

Permalink
feat(docs): add docs changelogs (#5617)
Browse files Browse the repository at this point in the history
* feat: added changelogs for Docs

* feat: added docs changelogs

* feat: added the logs for the 2024

* feat: updated changelogs for november

* feat: updated changelogs for november

* feat: add logs for each month that are more detailed with code snippets

* feat: cleaned up all docs based on catherines realistic feedback

* feat: removed extraneous changelogs

* feat: removed extraneous changelogs

---------

Co-authored-by: Kapil Gowru <[email protected]>
  • Loading branch information
kgowru and Kapil Gowru authored Jan 16, 2025
1 parent 7b37211 commit b181382
Show file tree
Hide file tree
Showing 16 changed files with 418 additions and 0 deletions.
2 changes: 2 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,8 @@ navigation:
- page: Publish your Docs
path: ./pages/docs/getting-started/publishing-your-docs.mdx
icon: fa-regular fa-cloud-arrow-up
- changelog: ./pages/changelogs/docs


- section: Building and Customizing Your Docs
contents:
Expand Down
Binary file added fern/images/changelogs/docs/api-explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fern/images/changelogs/docs/llms-txt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions fern/pages/changelogs/docs/2024-01-24.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## API Playground Launch
Enable interactive API testing directly in the documentation.
- Added full API request testing capability
- Improved error handling and status code display
- Added support for recursive property rendering

## Enhanced Dark Mode
Multiple improvements to dark mode readability for syntax highlighting, dropdowns, and search results.

```css
/* Dark mode improvements */
[data-theme='dark'] {
--syntax-bg: #1a1a1a;
--dropdown-bg: #2d2d2d;
--search-highlight: #ffd700;
}
```

## Mobile-Friendly Navigation
Comprehensive updates to mobile navigation experience with collapsible and scrolling.

## Search Enhancements
Multiple improvements to the search experience.
- Default and configurable keyboard shortcuts (`Cmd+A`, `/`) for search
- Improved search box sizing
- Added auto-focus functionality

## Performance Optimization
Several performance improvements across the platform.
- Moved FontAwesome to CDN
- Improved search dialog loading
- Optimized static props loading
- Added polyfill DOM parser for server-side TOC rendering
32 changes: 32 additions & 0 deletions fern/pages/changelogs/docs/2024-02-22.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## WebSocket Support in API Playground
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.

## Enhanced Code Highlighting
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.

## Feedback System
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.

## Layout Configuration System
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.

```yaml
layout:
page-width: full
tabs-placement: header
searchbar-placement: header
```
## Custom Styling Support
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.
```yaml docs.yml
css: ./assets/styles.css
```
```css styles.css
/* Custom styles */
.custom-class {
background-color: #f0f0f0;
}
```
26 changes: 26 additions & 0 deletions fern/pages/changelogs/docs/2024-03-24.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# March 2024

## Virtualized Syntax Highlighting
Implemented performance-optimized code rendering that handles large code blocks efficiently without impacting page performance. Long code samples now load instantly and scroll smoothly.

## Mobile Search Experience
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.

```css
.mobile-search-container {
position: sticky;
top: 0;
z-index: 50;
backdrop-filter: blur(8px);
}
```

## Scrollbar Refinement
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.

```css
.custom-scrollbar {
scrollbar-width: thin;
scrollbar-color: var(--scrollbar) transparent;
}
```
21 changes: 21 additions & 0 deletions fern/pages/changelogs/docs/2024-04-20.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Sidebar Navigation Enhancement
Improved sidebar padding and visual hierarchy with refined spacing and typography. The documentation navigation now provides clearer visual structure and better readability.

```css
.sidebar-section {
padding: theme('spacing.4');
border-left: 2px solid transparent;
&.active {
border-left-color: theme('colors.primary.500');
}
}
```

## Base Path Configuration
Added flexible base path configuration for documentation routing. Organizations can now host documentation under custom paths while maintaining proper navigation.

```yaml docs.yml
instances:
- url: your-site.docs.buildwithfern.com
custom-domain: your-site.com/docs
```
33 changes: 33 additions & 0 deletions fern/pages/changelogs/docs/2024-05-22.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Advanced Redirects
Implemented a powerful redirects system supporting pattern matching and parameter preservation. Teams can now manage documentation URL structure while maintaining backwards compatibility.

```yaml
redirects:
- source: /v1/api/*
destination: /v2/api/:splat
permanent: true
- source: /guides/:name
destination: /tutorials/:name
```
## Sitemap Optimization
Improved sitemap generation with direct file access and customizable update frequencies. Search engines can now better understand and index your documentation structure.
```typescript
const sitemapOptions = {
changefreq: 'weekly',
priority: 0.8,
lastmodISO: true
}
```

## API Authorization Handling
Enhanced API authorization handling in the documentation platform. Developers can now test authenticated endpoints more easily with improved token management.

```typescript
const authConfig = {
methods: ['bearer', 'apiKey'],
persistence: 'session',
autoRefresh: true
}
```
53 changes: 53 additions & 0 deletions fern/pages/changelogs/docs/2024-06-25.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# June 2024

## RSS Feed Integration
Added support for RSS feeds to keep users updated on documentation changes. Teams can now offer automated notifications for their documentation.

## JSON-LD Enhancement
Implemented structured data support through JSON-LD for improved SEO. Documentation pages now provide richer information to search engines and social platforms.

```json
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "API Authentication Guide",
"datePublished": "2024-06-15",
"technicalAudience": "Software Developers"
}
```

## Image Zoom Controls
Added configurable image zoom functionality with custom triggers and behaviors. Users can now better examine diagrams and technical illustrations in documentation.

```mdx page.mdx
---
no-image-zoom: true
---
```

## Syntax Extension Support
Added support for additional syntax highlighting languages including BAML and Jinja. Documentation can now properly display a wider range of code examples.

```html
<body>
<h1>Available Products</h1>
{% if products %}
<ul>
{% for product in products %}
<li class="product">
<h2>{{ product.name }}</h2>
<p class="price">${{ product.price }}</p>
<p>{{ product.description }}</p>
{% if product.in_stock %}
<p><strong>Status:</strong> In Stock</p>
{% else %}
<p><strong>Status:</strong> Out of Stock</p>
{% endif %}
</li>
{% endfor %}
</ul>
{% else %}
<p>No products are available at the moment.</p>
{% endif %}
</body>
```
37 changes: 37 additions & 0 deletions fern/pages/changelogs/docs/2024-07-30.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# July 2024

## Meta Image System
Implemented comprehensive meta image support for better social sharing. Documentation pages now display properly when shared on social media platforms.

```yaml
og:image: /assets/og-image.png
og:type: documentation
twitter:card: summary_large_image
twitter:image: /assets/twitter-card.png
```
## Type-Safe Components
Implemented strict TypeScript checking for documentation components. This ensures more reliable documentation rendering and easier maintenance.
```typescript
interface CodeBlockProps {
language: SupportedLanguage;
fileName?: string;
showLineNumbers: boolean;
highlight?: number[];
maxHeight?: number;
}
```

## Base Path Handling
Improved handling of base paths for search records and navigation.

```typescript
const pathConfig = {
stripBasePath: true,
rewriteRules: [
{ from: '/api/', to: '/reference/' },
{ from: '/v1/', to: '/v2/' }
]
}
```
46 changes: 46 additions & 0 deletions fern/pages/changelogs/docs/2024-08-20.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# August 2024

## Anchor Link System
Redesigned anchor link handling for improved navigation within documentation pages. Links now account for fixed headers and maintain proper scroll position.

```typescript
const anchorConfig = {
offset: 100,
smooth: true,
behavior: 'auto',
preserveHash: true
}
```

## WCAG Contrast Improvements
Enhanced color contrast throughout the documentation platform for better accessibility. All text and interactive elements now meet WCAG AA standards.

```css
:root {
--text-primary: #1a1a1a;
--text-secondary: #4a4a4a;
--link-color: #0056b3;
--code-inline: #bf1363;
}

[data-theme='dark'] {
--text-primary: #ffffff;
--text-secondary: #e0e0e0;
--link-color: #66b3ff;
--code-inline: #ff6b9d;
}
```

## API Page Center Updates
Improved center element positioning and updates for API documentation pages. Content now flows more naturally and maintains position during navigation.

```typescript
const centerElementConfig = {
updateThreshold: 0.2,
scrollBehavior: 'smooth',
debounceTime: 100
}
```

## Streaming Toggle Enhancement
Improved visibility and behavior of streaming response toggles in API playground. Users can now better control and monitor streaming responses.
24 changes: 24 additions & 0 deletions fern/pages/changelogs/docs/2024-09-24.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# September 2024

## Environment Testing Interface
Created an editable playground environment system for testing API endpoints. Users can now switch between different API environments seamlessly within the documentation.

```yaml openapi.yml
servers:
- url: https://api.example.com
x-fern-server-name: Production
- url: https://sandbox.example.com
x-fern-server-name: Sandbox
```
## Server Upload Validation
Improved file upload handling with better validation in documentation examples. Users can now better understand and test file upload endpoints.
```typescript
const uploadConfig = {
maxSize: '10MB',
allowedTypes: ['image/*', 'application/pdf'],
validateBeforeUpload: true,
showProgress: true
}
```
19 changes: 19 additions & 0 deletions fern/pages/changelogs/docs/2024-10-31.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# October 2024

## JWT API Key Integration
Implemented automatic API key extraction from JWT tokens in the documentation playground. Users can now test authenticated endpoints more easily with automatic credential handling.

```typescript
const jwtConfig = {
extractApiKey: true,
tokenLocation: 'header',
autoRefresh: true,
schema: {
apiKeyPath: 'payload.api_key',
rolePath: 'payload.permissions'
}
}
```

## Query Parameter Enhancement
Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation.
44 changes: 44 additions & 0 deletions fern/pages/changelogs/docs/2024-11-27.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## Auto-Populate Credentials in API Explorer

Save developers the hassle of finding and copying their API key. When authenticated, their API credentials will be automatically filled into the API Playground. This way, they can make their first API call even faster.

![API Explorer Splash Image](../../../../fern/images/changelogs/docs/api-explorer.png)

Check it out live in [Webflow's API Explorer](https://developers.webflow.com/data/reference/sites/list?playground=/data/reference/sites/list).

## Domain Management
Implemented comprehensive domain cleanup and management system. Documentation now handles multiple domains and environments more effectively.

```typescript
const domainConfig = {
cleanup: {
frequency: 'daily',
retainDays: 30,
backupBeforeClean: true
},
routing: {
primary: 'docs.example.com',
aliases: ['api-docs.example.com'],
forcePrimary: true
}
}
```

## Card Component System
Enhanced documentation card components for better visual organization. Information can now be presented in a more structured and appealing way.

```typescript
interface CardProps {
title: string;
description: string;
icon?: IconName;
variant?: 'default' | 'bordered' | 'filled';
actions?: CardAction[];
}

interface CardAction {
label: string;
href?: string;
onClick?: () => void;
}
```
Loading

0 comments on commit b181382

Please sign in to comment.