Skip to content

changelog.mdx

Latest commit

 

History

History
145 lines (101 loc) · 3.85 KB

changelog.mdx

File metadata and controls

145 lines (101 loc) · 3.85 KB
title Changelog
description Track the latest updates, new features, and improvements in Paperguide.

Overview

Paperguide releases updates regularly to enhance your documentation experience. You review this changelog to stay informed about new features, improvements, bug fixes, and breaking changes. Each release includes detailed notes on what changed and how it affects your workflow.

Subscribe to the RSS feed at `/rss.xml` to get notifications about new releases directly.

Recent Releases

Check the latest versions below. You find release notes organized by date, with semantic versioning for easy tracking.

<Update label="2024-10-15" description="v1.5.0" tags={["feature", "improvement"]}>

New Features

  • Added advanced search with full-text indexing across all documentation pages
  • Introduced real-time collaboration for teams to edit docs simultaneously
  • New version history viewer lets you compare changes between revisions

Improvements

  • Enhanced performance with lazy loading for large documentation sites
  • Updated UI components for better mobile responsiveness

Bug Fixes

  • Fixed rendering issues with nested code blocks in MDX files
  • Resolved export errors when including images in PDF generation

<Update label="2024-09-25" description="v1.4.2" tags={["bugfix", "security"]}>

Bug Fixes

  • Patched potential XSS vulnerability in user-uploaded images
  • Corrected sidebar navigation collapse on certain screen sizes
  • Fixed API rate limiting that blocked legitimate requests

Security

  • Updated all dependencies to latest secure versions

<Update label="2024-09-10" description="v1.4.0" tags={["feature", "breaking"]}>

New Features

  • Integrated custom domains for publishing documentation sites
  • Added analytics dashboard to track page views and user engagement

Breaking Changes

  • Removed legacy YAML frontmatter parser; migrate to standard format
  • API endpoints now require Authorization header instead of query params

Improvements

  • Optimized build times by 40% for sites with {100+} pages

Upgrading Paperguide

Follow these steps to upgrade your instance safely. You run these commands in your project root.

Create a full backup before proceeding.

cp -r ./docs ./docs-backup
git commit -m "Backup before upgrade"
```bash npm install paperguide@latest ``` ```bash yarn add paperguide@latest ```

Rebuild your documentation and deploy.

npm run build
npm run deploy
Review breaking changes in each release before upgrading production sites.

Quick Links

Full guides and API references. View all releases and download assets. Ask questions and report issues.

Version History Categories

Explore changes by type using these tabs.

New capabilities added in recent releases include search improvements and collaboration tools. Stability enhancements like XSS patches and navigation fixes. Deprecated parsers and updated auth methods—plan migrations accordingly.