Skip to content

docs(sdk): repository and documentation standards#16462

Merged
dingsdax merged 4 commits intomasterfrom
dev-docs/standards/repository-docs
Feb 19, 2026
Merged

docs(sdk): repository and documentation standards#16462
dingsdax merged 4 commits intomasterfrom
dev-docs/standards/repository-docs

Conversation

@dingsdax
Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Add new SDK standard for repository and documentation requirements. This standard defines mandatory repository files and documentation practices for all Sentry SDKs.

  • AGENTS.md - Required file covering architecture, testing, build instructions, and AI attribution
  • CONTRIBUTING.md - Setup, workflow, quality bar, and AI tools guidance
  • PR Template - Description structure and linked-issue reminders
  • Documentation-with-Code - Requirement for docs PRs to accompany user-facing changes
  • AI Context File Maintenance - Keeping AI context files current with quarterly reviews

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.):
  • Other deadline:
  • 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

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

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Feb 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Feb 19, 2026 6:36pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Feb 19, 2026 6:36pm

Request Review

@dingsdax dingsdax added the sdk-develop-docs PRs touching develop-docs/sdk label Feb 19, 2026
Copy link
Copy Markdown
Contributor

@stephanie-anderson stephanie-anderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Co-Authored-By: Claude <noreply@anthropic.com>
@dingsdax dingsdax changed the title Create repository-docs.mdx docs(sdk): repository and documentation standards Feb 19, 2026
Co-Authored-By: Claude <noreply@anthropic.com>
@dingsdax dingsdax merged commit 069e218 into master Feb 19, 2026
15 checks passed
@dingsdax dingsdax deleted the dev-docs/standards/repository-docs branch February 19, 2026 18:37
codyde added a commit that referenced this pull request Feb 19, 2026
* origin/master:
  docs(sdk): coordination and maintenance standards (#16463)
  docs(sdk): add spec format components and migrate check-ins (#16461)
  docs(sdk): repository and documentation standards (#16462)
  docs(sdk): Add issue saved replies and simplify CopyableCard (#16459)
  docs(sdk): add review & ci standard (#16458)
  fix(unity): correct lifecycle breadcrumbs docs (#16456)
  docs(sdk): add code quality standard (#16455)
  docs(sdk): migrate releases process to playbook and standard (#16447)
  docs(sdk): merge basics.mdx into overview.mdx (#16446)
  docs(sdk): remove old triaging process page (#16448)
  docs(dart): Update stacktrace info for the logging integration (#16401)
  docs(dart): Fix user attributes gated behind `sendDefaultPii` (#16407)
  feat(playstation): Add symbols documentation for dumps (#16454)
  feat(develop-docs): Restore Sentry Voice guidelines page (#16453)

# Conflicts:
#	app/[[...path]]/page.tsx
@github-actions github-actions bot locked and limited conversation to collaborators Mar 8, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants