From 5aed8b02e0800de8e31e350288aab1f6b2a1714f Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Fri, 29 Oct 2021 17:48:38 +0200 Subject: [PATCH] docs: add a minimal changelog page --- docs/changelog.md | 10 +++++++--- docs/links.yaml | 1 - 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index fe677e03..ede2a6d5 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -3,7 +3,11 @@ tableOfContents: true --- # Changelog +Tiptap consists of more than 50 separate packages, so it’s not that easy to keep that one big changelog. We got you covered though. Here is everything you need to follow the development during the beta phase: -:::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) -::: +1. You can find the [changelog for the core package](https://github.com/ueberdosis/tiptap/blob/main/packages/core/CHANGELOG.md) on GitHub here. +2. All packages have [a separate `CHANGELOG.md`](https://github.com/ueberdosis/tiptap/blob/main/packages), too. +3. During beta, it’s also helpful to keep an eye on the [merged Pull Requests on GitHub](https://github.com/ueberdosis/tiptap/pulls?q=is%3Apr+is%3Aclosed). +4. And we keep track of [what we want do do before a stable release](https://github.com/ueberdosis/tiptap/issues/2087) in a public issue. + +Once we’re transitioning to a stable version, [we’ll write blog posts](/blog) about bigger changes and keep them in a changelog here. diff --git a/docs/links.yaml b/docs/links.yaml index e8c5ce7f..ca8f357f 100644 --- a/docs/links.yaml +++ b/docs/links.yaml @@ -50,7 +50,6 @@ link: /overview/upgrade-guide - title: Changelog link: /changelog - type: draft - title: About the project link: /about type: sponsor