Feat add docs changelogs (#5624)

* 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 * feat: cleaned up based on andrews feedback * feat: cleaned up all hallucinated code --------- Co-authored-by: Kapil Gowru <[email protected]> Co-authored-by: Kapil Gowru <[email protected]>
fern-api · Jan 16, 2025 · 06aad51 · 06aad51
1 parent b181382
commit 06aad51
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 148 deletions.
diff --git a/fern/pages/changelogs/docs/2024-03-24.mdx b/fern/pages/changelogs/docs/2024-03-24.mdx
@@ -6,21 +6,5 @@ Implemented performance-optimized code rendering that handles large code blocks
 ## 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;
-}
-```
diff --git a/fern/pages/changelogs/docs/2024-04-20.mdx b/fern/pages/changelogs/docs/2024-04-20.mdx
@@ -1,16 +1,6 @@
 ## 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.
 

diff --git a/fern/pages/changelogs/docs/2024-05-22.mdx b/fern/pages/changelogs/docs/2024-05-22.mdx
@@ -10,24 +10,5 @@ redirects:
     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
-}
-```
diff --git a/fern/pages/changelogs/docs/2024-07-30.mdx b/fern/pages/changelogs/docs/2024-07-30.mdx
@@ -9,29 +9,3 @@ 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/' }
-  ]
-}
-```
diff --git a/fern/pages/changelogs/docs/2024-08-20.mdx b/fern/pages/changelogs/docs/2024-08-20.mdx
@@ -1,46 +1,13 @@
 # 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
-}
-```
+Redesigned anchor link handling for improved navigation within documentation pages. Links now account for fixed headers and maintain proper scroll position when opened.
 
 ## 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;
-}
-```
+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.
 
 ## 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.
diff --git a/fern/pages/changelogs/docs/2024-09-24.mdx b/fern/pages/changelogs/docs/2024-09-24.mdx
@@ -10,15 +10,3 @@ servers:
   - 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
-}
-```
diff --git a/fern/pages/changelogs/docs/2024-10-31.mdx b/fern/pages/changelogs/docs/2024-10-31.mdx
@@ -1,19 +1,11 @@
-# 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'
-  }
-}
-```
+<Card
+  title="Contact us to learn more"
+  variant="bordered"
+  href="/learn/home#get-support"
+/>
 
 ## Query Parameter Enhancement
 Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation.
diff --git a/fern/pages/changelogs/docs/2024-11-27.mdx b/fern/pages/changelogs/docs/2024-11-27.mdx
@@ -6,23 +6,6 @@ Save developers the hassle of finding and copying their API key. When authentica
 
 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.