-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add docs changelog #15169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs changelog #15169
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
💡 Enable Vercel Agent with $100 free credit for automated AI reviews |
Bundle ReportChanges will decrease total bundle size by 1.38MB (-5.85%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
Files in
App Routes Affected:
|
554621e
to
bafb355
Compare
5162e0c
to
bafb355
Compare
4fe4007
to
bafb355
Compare
0581547
to
bafb355
Compare
fe73de0
to
e5574f2
Compare
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR *Tell us what you're changing and why. If your PR **resolves an issue**, please link it so it closes automatically.* ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) Co-authored-by: Alex Krawiec <[email protected]>
947ffc4
to
0fa7052
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Amazing work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left some comments around the content parsing done by AI as well as structural questions. no real red flags but maybe we can clean it up a bit more
</header> | ||
|
||
<p className="mb-4 text-gray-700 dark:[color:rgb(210,199,218)]"> | ||
{entry.description} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my concern is that description
currently lists changed files where we have filesChanged
below it which could result in duplicate content. Is this something we can control a bit better and pull out an informative description of the actual file changes and list the files below?
href={entry.url} | ||
target="_blank" | ||
rel="noopener noreferrer" | ||
className="text-primary hover:underline" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.

Looks like the hover:underline
is not being applied since it's a heading. I do think there should be an underline. But this creates a separate issue: it looks like .prose
class is being applied which has some default styling for content on other docs pages. Things like text color, etc. Maybe it's worth removing all tailwind classes and seeing which ones are needed to get it to the desired look (border bottom after sections, etc) and leave a lot of it to default to the same styling as the other pages?
})} | ||
{entries.length > 20 && ( | ||
<div className="mt-8 rounded-lg border border-gray-200 bg-gray-50 p-4 text-center dark:border-gray-700 dark:bg-gray-800"> | ||
<p className="text-sm text-gray-600 dark:[color:rgb(210,199,218)]"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we just use our Alert
component here?
DESCRIBE YOUR PR
TLDR: A monitoring repo does a chron job that collects docs updates and summarizes them using chat GPT, then it's passed over to the Content Dashboard repo which generates an RSS feed, and the docs repo pings that RSS feed to populate the data on this page:
https://sentry-docs-git-changelog.sentry.dev/changelog/
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES